Screenshot

Capture a start/stop screenshot

POST

http://localhost:3000/api/timesheet/screenshot

Captures a screenshot when the timer is started or stopped. This API allows uploading the screenshot file along with related metadata.

curl -X POST 'http://localhost:3000/api/timesheet/screenshot' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "file": "string",
  "thumb": "string",
  "storageProvider": "LOCAL",
  "isWorkRelated": "string",
  "description": "string",
  "timeSlotId": "string",
  "userId": "string"
}'

const body = `{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "file": "string",
  "thumb": "string",
  "storageProvider": "LOCAL",
  "isWorkRelated": "string",
  "description": "string",
  "timeSlotId": "string",
  "userId": "string"
}`;

const response = await fetch('http://localhost:3000/api/timesheet/screenshot', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "file": "string",
  "thumb": "string",
  "storageProvider": "LOCAL",
  "isWorkRelated": "string",
  "description": "string",
  "timeSlotId": "string",
  "userId": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/timesheet/screenshot',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "file": "string",
  "thumb": "string",
  "storageProvider": "LOCAL",
  "isWorkRelated": "string",
  "description": "string",
  "timeSlotId": "string",
  "userId": "string"
}

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "file": "string",
  "thumb": "string",
  "storageProvider": "LOCAL",
  "isWorkRelated": "string",
  "description": "string",
  "timeSlotId": "string",
  "userId": "string"
}

Body

application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

filestringrequired

thumbstring

recordedAttimestamptz

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

isWorkRelatedstring

Specifies whether the image or screenshot is work-related.

descriptionstring

Description of the image or screenshot.

appsjson

Applications associated with the image or screenshot.

timeSlotIdstring

userIdstring

Response

200OKScreenshot

Screenshot captured successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

filestringrequired

thumbstring

recordedAttimestamptz

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

isWorkRelatedstring

Specifies whether the image or screenshot is work-related.

descriptionstring

Description of the image or screenshot.

appsjson

Applications associated with the image or screenshot.

timeSlotIdstring

userIdstring

400Bad Request

Invalid input provided. Check the response body for error details.

Stack Overflow Website Demo