Download OpenAPI specification:Download
This is a in progress documentation for SokoPro REST API.
Remarks:
- the endpoints of some download and upload operations have a different server providing streaming capabilities
- at some point, the integer type of id's (of projects, folders and files) will be deprecated in favor of string uuid's exclusively.
The authentication methods required for successful operation authentication.
Can be used to get client_credentials or password_grant by defining grant_type to client_credentials or password_grant
authorization_code (object) or client_credentials (object) or client_credentials_username_password (object) or password_grant (object) Query parameters to be used for token request. It's recommended to use authorization_code. Other grant types are supported for previous users. |
{- "data": {
- "token_type": "string",
- "access_token": "string"
}
}
Authorize client
response_type required | string Value: "code" For the moment supported response_type is code |
client_id required | string Example: client_id=exampleclientid Registered client identifier |
redirect_uri required | string Example: redirect_uri=httpspreviously.requested.redirect.address.com Client's redirection endpoint, which has been added to the client during client registration |
scope required | string Value: "full_access" For the moment only supported scope is full_access |
state required | string State value from client |
{- "data": {
- "response_type": "code",
- "client_id": "string",
- "scope": "string",
- "state": "string",
- "code": "string"
}
}
Authorize client
response_type required | string Value: "code" For the moment supported response_type is code |
client_id required | string Registered client identifier |
redirect_uri required | string Client's redirection endpoint, which has been added to the client during client registration |
scope required | string Value: "full_access" For the moment only supported scope is full_access |
state required | string State value from client |
{- "data": {
- "response_type": "code",
- "client_id": "string",
- "scope": "string",
- "state": "string",
- "code": "string"
}
}
Specific information about the user
{- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}
[- {
- "total": 0,
- "projects": [
- {
- "id": 0,
- "projectId": 0,
- "cover": "string",
- "description": "string",
- "metadata": [
- {
- "uuid": "string",
- "order": 0,
- "identifier": "string",
- "mandatory": true,
- "hideOnFileList": true
}
], - "customerId": 0,
- "salesRepresentive": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "printProvider": 0,
- "notes": "string",
- "integrations": true,
- "notifyFollowing": [
- "string"
], - "projectAdmins": [
- "string"
], - "permission": true,
- "addressDetails": {
- "id": "string",
- "customerName": "string",
- "streetAddress": "string",
- "postalCode": "string",
- "city": "string",
- "country": "string"
}, - "customerName": "string",
- "customerSalesRepresentative": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "projectType": [
- "ProjectTypeFinished"
], - "uuid": "string",
- "name": "string",
- "status": "string"
}
]
}
]
Get information about specific project
projectId required | integer <int64> Id of the project as integer |
{- "id": 0,
- "type": "string",
- "projectId": 0,
- "uuid": "string",
- "rootFolderIdentifier": "string",
- "rootFolder": "string",
- "bookmarked": true,
- "updatedAt": "string",
- "visitedAt": "string",
- "perm": 0,
- "showPartiesTab": true,
- "template": true,
- "Author": {
- "id": 0,
- "uuid": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "company": null,
- "avatar": "string"
}, - "createdAt": "string",
- "deletedAt": "string"
}
Get project's metadata schema which is useful as an example when saving uploaded files
projectId required | integer <int64> Id of the project as integer |
{- "project_id": 0,
- "metadata": [
- {
- "uuid": "string",
- "order": 0,
- "identifier": "string",
- "mandatory": true,
- "hideOnFileList": true
}
], - "created_at": "string",
- "updated_at": 0,
- "deleted_at": 0
}
End point which can be used to copy one project to a new project.
Usage of this endpoint is limited to customer admins and this is not available for normal users.
Body will contain the information of the source template to be used and which data will be copied or not for the new project
type | string Type of source project, only valid value for this is "TEMPLATE" |
copyFrom | integer Id of the source template project |
projectName | string New project name |
projectDescription | string New project desciption |
folderStructure | boolean Will the folder structure to be copied. This value must be true. |
files | boolean Will the files to be copied. This value must be true. |
userGroups | boolean Will the user groups to be copied. This value must be true. |
users | boolean Will the users to be copied. This value must be true. |
{- "type": "TEMPLATE",
- "copyFrom": 0,
- "projectName": "string",
- "projectDescription": "string",
- "folderStructure": true,
- "files": true,
- "userGroups": true,
- "users": true
}
{- "id": 0,
- "type": "string",
- "uuid": "string",
- "name": "string",
- "rootFolderIdentifier": "string",
- "rootFolder": 0,
- "bookmarked": true,
- "projectStatus": {
- "id": 0,
- "uuid": "string",
- "name": "string",
- "inUser": "string"
}, - "projectType": {
- "id": 0,
- "uuid": "string",
- "name": "string",
- "inUser": "string"
}, - "projectAdmins": [
- ""
], - "customerName": "string",
- "template": true,
- "description": "string",
- "hasNotes": true,
- "showPartiesTab": true,
- "projectId": 0,
- "updatedAt": 0,
- "visitedAt": null,
- "perm": 0,
- "notes": "string",
- "customer": {
- "id": 0,
- "uuid": "string",
- "type": "string",
- "name": "string",
- "businessId": "string"
}, - "author": {
- "id": 0,
- "uuid": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "company": null,
- "avatar": "string"
}, - "billingInformations": [
- { }
], - "notifyFollowing": [
- ""
], - "createdAt": 0,
- "conversionService": "string"
}
List the content of the folder. This endpoint can be used to list latest files in project as well
projectId required | integer <int64> Id of the project as integer |
folderId required | integer <int64> Id of the folder as integer |
toggleRecents | boolean Toggle reacents option on or off |
includeSubFolders | boolean Determine if subfolders and their contents will be included or not |
date | number From date |
dateTo | number To date |
{- "files": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "node": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "path": [
- {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}
], - "total": 0
}
Return revision of the filer
fileId required | integer <int64> If of file as integer |
[- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
]
Return latest revision of requested file or error
fileUuid required | string fileUuid of the requested file |
{- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
Creating folder is a two step process. Before one can create a folder, one must check it's existance.
description | string Folder description |
name required | string Folder name |
parent required | number Parent folder id |
project required | number Project number |
type required | string Value: "Folder" |
{- "description": "string",
- "name": "string",
- "parent": 0,
- "project": 0,
- "type": "Folder"
}
{- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}
When used with file revisions or folders this resource will return metadata of the given items. Alternatively, when 'uuids' is a sessionUuid and type is 'SESSION' the resource will return the metadata of the upload session.
uuids required | Array of strings List of file revisions, folders or session as uuid |
type required | string Enum: "REVISION_OR_FOLDER" "SESSION" |
{- "uuids": [
- "string"
], - "type": "REVISION_OR_FOLDER"
}
{- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
Edit folder or file information, can be used but not limited to rename or change description of selected item
id required | number |
Values should contain an object of key value pairs corresponding to the project meta data schema. In the example
file required | number |
required | object |
{- "file": 0,
- "values": {
- "1": "Example",
- "2": "Example for testing purposes"
}
}
{- "id": 0,
- "type": "string",
- "name": "string",
- "uuid": "string",
- "bookmarked": true,
- "parent": 0,
- "parentUuid": "string",
- "project": 0,
- "projectUuid": "string",
- "author": null,
- "customMeta": [
- {
- "id": 0,
- "value": 0,
- "order": 0,
- "name": "string",
- "mandatory": true,
- "identifier": "string",
- "uuid": "string",
- "hideOnFileList": true,
- "options": [
- { }
], - "type": "string",
- "required": true,
- "editable": true
}
], - "notifications": {
- "pushnotifications": true,
- "email": true
}, - "perm": 0,
- "length": 0,
- "meta": {
- "filename": "string",
- "size": 0,
- "created_at": 0
}
}
Delete requested revision of a file. This can't be used to remove revision if there's only 1 revision, for that purposes one should use the other delete endpoint.
uuid required | string non-empty |
{- "uuid": "string"
}
{- "id": 0,
- "name": "string",
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "parentUuid": "string",
- "project": 0,
- "projectUuid": "string",
- "version": 0,
- "author": {
- "id": 0,
- "uuid": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "company": null,
- "avatar": "string"
}, - "customMeta": [
- {
- "id": 0,
- "name": "string",
- "identifier": "string",
- "order": 0,
- "type": "string",
- "required": true,
- "editable": true,
- "mandatory": true,
- "options": [
- {
- "name": "string",
- "order": 0,
- "value": 0
}
], - "hideOnFileList": true,
- "uuid": "string",
- "value": "string"
}
], - "notifications": {
- "pushnotifications": true,
- "email": true
}, - "prev": null,
- "next": null,
- "meta": {
- "content_type": "string",
- "filename": "string",
- "size": 0,
- "created_at": 0
}
}
items which will be moved and the destination
uuids required | Array of strings folder or file uuids which will be moved |
ignored required | Array of strings |
destination required | string non-empty folder uuid where items will be moved into |
{- "uuids": [
- "string"
], - "ignored": [
- "string"
], - "destination": "string"
}
{- "message": true
}
Copy requested folders or files to the requested destination. In the case the destination contains folder or file with the same name the file will be revisioned and folder will be renamed with a number as an example if you are moving folder name "Example" and the destination already has that folder the copied folder will be renamed "Example (1)"
items which will be copied and the destination
uuids required | Array of strings |
ignored required | Array of strings |
destination required | string non-empty |
{- "uuids": [
- "string"
], - "ignored": [
- "string"
], - "destination": "string"
}
{- "status": 0,
- "message": true
}
Uploading file(s) requires multiple steps to complete the operation to get file(s) visible and usable.
When used with file revisions or folders this resource will return metadata of the given items. Alternatively, when 'uuids' is a sessionUuid and type is 'SESSION' the resource will return the metadata of the upload session.
uuids required | Array of strings List of file revisions, folders or session as uuid |
type required | string Enum: "REVISION_OR_FOLDER" "SESSION" |
{- "uuids": [
- "string"
], - "type": "REVISION_OR_FOLDER"
}
{- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
Creates an upload session which is used to upload a certain set of files. The upload session is treated as a single upload process.
parentFolderUUID required | string The uuid of the parent folder |
{- "parentFolderUUID": "string"
}
{- "created_at": 0,
- "finished": 0,
- "id": 0,
- "parent": 0,
- "pending": 0,
- "project": "string",
- "uuid": "string",
- "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}
}
Get information about an upload session to verify pending and finished file uploads
sessionUuid required | string The uuid of the upload session |
{- "created_at": 0,
- "finished": 0,
- "id": 0,
- "parent": 0,
- "pending": 0,
- "project": "string",
- "uuid": "string",
- "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}
}
This operation uploads files. N.B. meta data needs to be set separately after succesful file upload to complete the full upload process.
Content-Type required | string application/offset+octet-stream |
Content-Size required | integer <int64> The size of the content as an integer to be streamed. |
Upload-Length required | integer <int64> The length as an integer of streamed octet. |
Upload-Offset required | integer <int64> The offset of stream as an integer. |
Upload-Metadata required | string Example: filename ZXhhbXBsZS5wZGY=,filetype YXBwbGljYXRpb24vcGRm,parent NTUw,project NTQ2,projectUuid ZDk5MjIzZjAtNDU3Yy00ZDBmLWJmNjktYmI2MmE4YTg4ODQx,parentUUID NWY1ZDY5OGEtYWQ3Ny00M2UyLTg0MWUtODQ3ZjI5YzQxOGY3,session NmJjMWM4NDQtYTA3Yi00MDRkLTg1MzMtZjI2YWEzNWE5NTJk,unzip ZmFsc2U=,replace ZmFsc2U=,file This header describes some file meta data for system required processing purposes. The string value is a comma separated list of keys and base64 encoded values. Required keys: filename, filetype, parent, project, projectUuid, parentUUID, session, unzip, replace and file. |
{- "name": "string",
- "uuid": "string",
- "file": {
- "file": 0,
- "id": 0,
- "name": "string",
- "meta": {
- "filename": "string",
- "size": 0,
- "content_type": 0
}
}
}
Save the given upload session files with their corresponding provided meta data. Files will be available on files listing after they have been saved
hierarchyType required | string Value: "SESSION" |
sessionUuid required | string The uuid of the upload session |
required | object Dictionaries of file revision uuid's containing custom meta data objects |
{- "hierarchyType": "SESSION",
- "sessionUuid": "string",
- "metas": {
- "revisionUuid": {
- "uuid": "metadataUuid",
- "name-meta": "",
- "description-meta": "",
- "change-date-meta": "",
- "color-meta": "",
- "scale-meta": "",
- "added-meta": "",
- "added-by-meta": "",
- "change-meta": "",
- "status-meta": "",
- "create-date-meta": "",
- "revision-meta": ""
}
}
}
{- "created_at": 0,
- "finished": 0,
- "id": 0,
- "parent": 0,
- "pending": 0,
- "project": "string",
- "uuid": "string",
- "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}
}
Before uploading a file, it's existence can be verified using this operation
parent required | number Id of the project as integer |
required | Array of objects |
{- "parent": 0,
- "files": [
- {
- "name": "string",
- "type": "string"
}
]
}
{- "data": true
}
The offered resource to download multiple files and/or folders expects a pre-generated URL part. This endpoint generates that needed URL part.
uuids | Array of strings List of folder and/or files uuids |
{- "uuids": [
- "string"
]
}
{- "url": "string"
}
SokoSite forms of the project
projectId required | integer <int64> Id of the project as integer |
[- {
- "id": 0,
- "diary_uuid": "string",
- "form_type": "string",
- "name": "string",
- "site_number": "string",
- "entries": 0,
- "waiting_for_signatures": 0,
- "ready": 0
}
]
Worksite diary info
worksiteDiaryUUID required | string UUID of the worksite diary |
{- "id": 0,
- "diary_uuid": "string",
- "project_uuid": "string",
- "form_type": "string",
- "name": "string",
- "site_number": "string",
- "perm": 0,
- "usergroup_id": 0,
- "created_at": "string",
- "folder_id": 0,
- "folder_uuid": "string"
}
Fetches all worksite diaries
projectUuid required | string UUID of the project |
[- {
- "id": 0,
- "diary_uuid": "string",
- "project_uuid": "string",
- "form_type": "string",
- "name": "string",
- "site_number": "string",
- "perm": 0,
- "usergroup_id": 0,
- "created_at": "string",
- "folder_id": 0,
- "folder_uuid": "string"
}
]
worksiteDiaryUUID required | string UUID of the diary |
diary_uuid required | string |
diary_date required | string |
{- "diary_uuid": "string",
- "diary_date": "2022-08-15T12:22:21+03:00"
}
{- "id": 0,
- "entry_uuid": "string",
- "diary_uuid": "string",
- "created_by": "string",
- "diary_date": "string",
- "updated_by": "string",
- "deleted_at": 0,
- "weather_info": {
- "tempAt7": null,
- "conditionAt7": "string",
- "disturbanceAt7": true,
- "tempAt12": null,
- "conditionAt12": "string",
- "disturbanceAt12": true
}, - "plan_info": "string",
- "review_info": 0,
- "small_critical_changes": "string",
- "change_offers": "string",
- "additional_time": "string",
- "supervisor_notes": "string",
- "additional_notes": "string",
- "employee_status": {
- "name": "string",
- "count": 0
}, - "equipment_status": {
- "name": "string",
- "count": 0
}, - "jobs": [
- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
], - "comments": [
- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
], - "other_notes": "string",
- "master_signature": "string",
- "supervisor_signature": "string",
- "created_at": 0,
- "updated_at": 0,
- "ui_diary_date": "string",
- "ui_created_at": "string",
- "ui_updated_at": "string",
- "workday": 0,
- "folder_uuid": "string",
- "folder_id": 0,
- "images_folder_uuid": "string",
- "images_folder_id": 0,
- "folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "images_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "attachments": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "images": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "next_entry_uuid": "string",
- "previous_entry_uuid": "string"
}
worksiteDiaryUUID required | string UUID of the diary |
[- {
- "id": 0,
- "entry_uuid": "string",
- "diary_uuid": "string",
- "created_by": "string",
- "diary_date": "string",
- "updated_by": "string",
- "deleted_at": 0,
- "weather_info": {
- "tempAt7": null,
- "conditionAt7": "string",
- "disturbanceAt7": true,
- "tempAt12": null,
- "conditionAt12": "string",
- "disturbanceAt12": true
}, - "plan_info": "string",
- "review_info": 0,
- "small_critical_changes": "string",
- "change_offers": "string",
- "additional_time": "string",
- "supervisor_notes": "string",
- "additional_notes": "string",
- "employee_status": {
- "name": "string",
- "count": 0
}, - "equipment_status": {
- "name": "string",
- "count": 0
}, - "jobs": [
- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
], - "comments": [
- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
], - "other_notes": "string",
- "master_signature": "string",
- "supervisor_signature": "string",
- "created_at": 0,
- "updated_at": 0,
- "ui_diary_date": "string",
- "ui_created_at": "string",
- "ui_updated_at": "string",
- "workday": 0,
- "folder_uuid": "string",
- "folder_id": 0,
- "images_folder_uuid": "string",
- "images_folder_id": 0,
- "folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "images_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "attachments": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "images": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "next_entry_uuid": "string",
- "previous_entry_uuid": "string"
}
]
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
{- "id": 0,
- "entry_uuid": "string",
- "diary_uuid": "string",
- "created_by": "string",
- "diary_date": "string",
- "updated_by": "string",
- "deleted_at": 0,
- "weather_info": {
- "tempAt7": null,
- "conditionAt7": "string",
- "disturbanceAt7": true,
- "tempAt12": null,
- "conditionAt12": "string",
- "disturbanceAt12": true
}, - "plan_info": "string",
- "review_info": 0,
- "small_critical_changes": "string",
- "change_offers": "string",
- "additional_time": "string",
- "supervisor_notes": "string",
- "additional_notes": "string",
- "employee_status": {
- "name": "string",
- "count": 0
}, - "equipment_status": {
- "name": "string",
- "count": 0
}, - "jobs": [
- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
], - "comments": [
- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
], - "other_notes": "string",
- "master_signature": "string",
- "supervisor_signature": "string",
- "created_at": 0,
- "updated_at": 0,
- "ui_diary_date": "string",
- "ui_created_at": "string",
- "ui_updated_at": "string",
- "workday": 0,
- "folder_uuid": "string",
- "folder_id": 0,
- "images_folder_uuid": "string",
- "images_folder_id": 0,
- "folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "images_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "attachments": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "images": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "next_entry_uuid": "string",
- "previous_entry_uuid": "string"
}
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
id required | number |
entry_uuid required | string |
diary_uuid required | string |
created_by required | string |
diary_date required | string |
updated_by | string |
deleted_at | number |
object (Weather) | |
plan_info | string |
review_info | number |
small_critical_changes | string |
change_offers | string |
additional_time | string |
supervisor_notes | string |
additional_notes | string |
object (EmployeeOrEquipment) | |
object (EmployeeOrEquipment) | |
Array of objects (Job) | |
Array of objects (Comment) | |
other_notes | string |
master_signature | string |
supervisor_signature | string |
created_at | number |
updated_at | number |
ui_diary_date | string |
ui_created_at | string |
ui_updated_at | string |
workday | number |
folder_uuid | string |
folder_id | number |
images_folder_uuid | string |
images_folder_id | number |
object (Folder) | |
object (Folder) | |
Array of Revision (object) or Folder (object) (RevisionOrFolder) | |
Array of Revision (object) or Folder (object) (RevisionOrFolder) | |
next_entry_uuid | string |
previous_entry_uuid | string |
{- "id": 0,
- "entry_uuid": "string",
- "diary_uuid": "string",
- "created_by": "string",
- "diary_date": "string",
- "updated_by": "string",
- "deleted_at": 0,
- "weather_info": {
- "tempAt7": null,
- "conditionAt7": "string",
- "disturbanceAt7": true,
- "tempAt12": null,
- "conditionAt12": "string",
- "disturbanceAt12": true
}, - "plan_info": "string",
- "review_info": 0,
- "small_critical_changes": "string",
- "change_offers": "string",
- "additional_time": "string",
- "supervisor_notes": "string",
- "additional_notes": "string",
- "employee_status": {
- "name": "string",
- "count": 0
}, - "equipment_status": {
- "name": "string",
- "count": 0
}, - "jobs": [
- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
], - "comments": [
- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
], - "other_notes": "string",
- "master_signature": "string",
- "supervisor_signature": "string",
- "created_at": 0,
- "updated_at": 0,
- "ui_diary_date": "string",
- "ui_created_at": "string",
- "ui_updated_at": "string",
- "workday": 0,
- "folder_uuid": "string",
- "folder_id": 0,
- "images_folder_uuid": "string",
- "images_folder_id": 0,
- "folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "images_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "attachments": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "images": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "next_entry_uuid": "string",
- "previous_entry_uuid": "string"
}
{- "id": 0,
- "entry_uuid": "string",
- "diary_uuid": "string",
- "created_by": "string",
- "diary_date": "string",
- "updated_by": "string",
- "deleted_at": 0,
- "weather_info": {
- "tempAt7": null,
- "conditionAt7": "string",
- "disturbanceAt7": true,
- "tempAt12": null,
- "conditionAt12": "string",
- "disturbanceAt12": true
}, - "plan_info": "string",
- "review_info": 0,
- "small_critical_changes": "string",
- "change_offers": "string",
- "additional_time": "string",
- "supervisor_notes": "string",
- "additional_notes": "string",
- "employee_status": {
- "name": "string",
- "count": 0
}, - "equipment_status": {
- "name": "string",
- "count": 0
}, - "jobs": [
- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
], - "comments": [
- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
], - "other_notes": "string",
- "master_signature": "string",
- "supervisor_signature": "string",
- "created_at": 0,
- "updated_at": 0,
- "ui_diary_date": "string",
- "ui_created_at": "string",
- "ui_updated_at": "string",
- "workday": 0,
- "folder_uuid": "string",
- "folder_id": 0,
- "images_folder_uuid": "string",
- "images_folder_id": 0,
- "folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "images_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "attachments": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "images": [
- {
- "project": 0,
- "projectUuid": "string",
- "parentUuid": "string",
- "description": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "author": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "preview": {
- "uuid": "string",
- "status": "string"
}, - "id": 0,
- "uuid": "string",
- "file": 0,
- "fileUuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0,
- "version": 0,
- "customMeta": [
- {
- "uuid": "string",
- "value": "string"
}
]
}
], - "next_entry_uuid": "string",
- "previous_entry_uuid": "string"
}
Post a comment onto a entry
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
id | number |
comment_uuid | string |
entry_id | string |
created_at | string |
comment | string |
object (User) | |
user_fullname | string |
{- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
{- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
Gets all comments for the entry
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
[- {
- "id": 0,
- "comment_uuid": "string",
- "entry_id": "string",
- "created_at": "string",
- "comment": "string",
- "user": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "user_fullname": "string"
}
]
Updates jobs and their statuses for the diary entry
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
name | string |
object (JobRevision) | |
id | number |
job_uuid | string |
[- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
]
[- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
]
Gets all job statuses for the entry
worksiteDiaryUUID required | string |
worksiteDiaryEntryUUID required | string |
[- {
- "name": "string",
- "new_revision": {
- "status": "STARTED",
- "notes": "string",
- "updated_at": "string",
- "id": "string",
- "uuid": "string",
- "entry_uuid": "string",
- "deleted_at": "string"
}, - "id": 0,
- "job_uuid": "string"
}
]
TR/MVR meter info
trmvrMeterUUID required | string UUID of the meter |
{- "id": 0,
- "trmvrmeter_uuid": "string",
- "project_uuid": "string",
- "form_type": "string",
- "name": "string",
- "site_number": "string",
- "perm": 0,
- "usergroup_id": 0,
- "created_at": 0,
- "folder_id": 0,
- "folder_uuid": "string"
}
Gets all TR/MVR meters for the project
projectUuid required | string UUID of the project |
[- {
- "id": 0,
- "trmvrmeter_uuid": "string",
- "project_uuid": "string",
- "form_type": "string",
- "name": "string",
- "site_number": "string",
- "perm": 0,
- "usergroup_id": 0,
- "created_at": 0,
- "folder_id": 0,
- "folder_uuid": "string"
}
]
Creates a new TR/MVR entry for the given date
trmvrMeterUUID required | string UUID of the TR/MVR meter |
date required | string Date for which to create new entry |
{- "date": "2022-08-15T12:22:21+03:00"
}
{- "id": 0,
- "uuid": "string",
- "trmeter_uuid": "string",
- "date": "string",
- "ui_date": "string",
- "week_number": "string",
- "draft": true,
- "meter_type": "TRMETER",
- "created_by": "string",
- "ui_created_by": 0,
- "measurements": [
- {
- "correct": 0,
- "wrong": 0
}
], - "folder_uuid": "string",
- "folder_id": 0,
- "employer_signature": "string",
- "employee_signature": "string",
- "created_at": "string",
- "updated_at": "string",
- "deleted_at": "string",
- "remark_status": "string"
}
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
{- "id": 0,
- "uuid": "string",
- "trmeter_uuid": "string",
- "date": "string",
- "ui_date": "string",
- "week_number": "string",
- "draft": true,
- "meter_type": "TRMETER",
- "created_by": "string",
- "ui_created_by": 0,
- "measurements": [
- {
- "correct": 0,
- "wrong": 0
}
], - "folder_uuid": "string",
- "folder_id": 0,
- "employer_signature": "string",
- "employee_signature": "string",
- "created_at": "string",
- "updated_at": "string",
- "deleted_at": "string",
- "remark_status": "string"
}
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
id required | number |
uuid | string |
trmeter_uuid | string |
date | string |
ui_date | string |
week_number | string |
draft | boolean |
meter_type | string Enum: "TRMETER" "MVRMETER" |
created_by | string |
ui_created_by | number |
Array of objects (Measurement) | |
folder_uuid required | string |
folder_id required | number |
employer_signature | string |
employee_signature | string |
created_at required | string |
updated_at | string |
deleted_at | string |
remark_status | string |
{- "id": 0,
- "uuid": "string",
- "trmeter_uuid": "string",
- "date": "string",
- "ui_date": "string",
- "week_number": "string",
- "draft": true,
- "meter_type": "TRMETER",
- "created_by": "string",
- "ui_created_by": 0,
- "measurements": [
- {
- "correct": 0,
- "wrong": 0
}
], - "folder_uuid": "string",
- "folder_id": 0,
- "employer_signature": "string",
- "employee_signature": "string",
- "created_at": "string",
- "updated_at": "string",
- "deleted_at": "string",
- "remark_status": "string"
}
{- "id": 0,
- "uuid": "string",
- "trmeter_uuid": "string",
- "date": "string",
- "ui_date": "string",
- "week_number": "string",
- "draft": true,
- "meter_type": "TRMETER",
- "created_by": "string",
- "ui_created_by": 0,
- "measurements": [
- {
- "correct": 0,
- "wrong": 0
}
], - "folder_uuid": "string",
- "folder_id": 0,
- "employer_signature": "string",
- "employee_signature": "string",
- "created_at": "string",
- "updated_at": "string",
- "deleted_at": "string",
- "remark_status": "string"
}
trmvrMeterUUID required | string UUID of the TR/MVR meter |
[- {
- "id": 0,
- "uuid": "string",
- "trmeter_uuid": "string",
- "date": "string",
- "ui_date": "string",
- "week_number": "string",
- "draft": true,
- "meter_type": "TRMETER",
- "created_by": "string",
- "ui_created_by": 0,
- "measurements": [
- {
- "correct": 0,
- "wrong": 0
}
], - "folder_uuid": "string",
- "folder_id": 0,
- "employer_signature": "string",
- "employee_signature": "string",
- "created_at": "string",
- "updated_at": "string",
- "deleted_at": "string",
- "remark_status": "string"
}
]
Creates a new entry remark for the TR/MVR meter
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
{- "entry_uuid": "string",
- "created_by": 0,
- "meter_type": "TRMETER"
}
Fetch entry remark
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
trmvrMeterEntryRemarkUUID required | string UUID of the entry remark |
{- "id": 0,
- "uuid": "string",
- "entry_uuid": "string",
- "created_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "confirmed_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "meter_type": "TRMETER",
- "target": "string",
- "remark": 0,
- "responsible_company": 0,
- "must_be_fixed_at": "string",
- "additional_info": "string",
- "confirmed_at": "string",
- "confirmation_comment": "string",
- "created_at": "string",
- "updated_at": "string",
- "image_folder_id": 0,
- "image_folder_uuid": "string",
- "image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "confirmation_image_folder_id": 0,
- "confirmation_image_folder_uuid": "string",
- "confirmation_image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "remark_status": "string"
}
Fetch TR/MVR meter entry remarks
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
[- {
- "id": 0,
- "uuid": "string",
- "entry_uuid": "string",
- "created_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "confirmed_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "meter_type": "TRMETER",
- "target": "string",
- "remark": 0,
- "responsible_company": 0,
- "must_be_fixed_at": "string",
- "additional_info": "string",
- "confirmed_at": "string",
- "confirmation_comment": "string",
- "created_at": "string",
- "updated_at": "string",
- "image_folder_id": 0,
- "image_folder_uuid": "string",
- "image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "confirmation_image_folder_id": 0,
- "confirmation_image_folder_uuid": "string",
- "confirmation_image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "remark_status": "string"
}
]
Update existing TR/MVR entry remark
trmvrMeterUUID required | string UUID of the TR/MVR meter |
trmvrmeterEntryUUID required | string UUID of the entry |
remarkUUID required | string UUID of the remark |
{- "id": 0,
- "uuid": "string",
- "entry_uuid": "string",
- "created_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "confirmed_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "meter_type": "TRMETER",
- "target": "string",
- "remark": 0,
- "responsible_company": 0,
- "must_be_fixed_at": "string",
- "additional_info": "string",
- "confirmed_at": "string",
- "confirmation_comment": "string",
- "created_at": "string",
- "updated_at": "string",
- "image_folder_id": 0,
- "image_folder_uuid": "string",
- "image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "confirmation_image_folder_id": 0,
- "confirmation_image_folder_uuid": "string",
- "confirmation_image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "remark_status": "string"
}
trmvrMeterUUID required | string UUID of the TR/MVR meter |
[- {
- "id": 0,
- "uuid": "string",
- "entry_uuid": "string",
- "created_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "confirmed_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "meter_type": "TRMETER",
- "target": "string",
- "remark": 0,
- "responsible_company": 0,
- "must_be_fixed_at": "string",
- "additional_info": "string",
- "confirmed_at": "string",
- "confirmation_comment": "string",
- "created_at": "string",
- "updated_at": "string",
- "image_folder_id": 0,
- "image_folder_uuid": "string",
- "image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "confirmation_image_folder_id": 0,
- "confirmation_image_folder_uuid": "string",
- "confirmation_image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "remark_status": "string"
}
]
Fetches all TR/MVR meter remarks that haven't been confirmed
trmvrMeterUUID required | string UUID of the TR/MVR meter |
[- {
- "id": 0,
- "uuid": "string",
- "entry_uuid": "string",
- "created_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "confirmed_by": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "firstTimeLogin": false,
- "company": "string",
- "avatar": "string",
- "hasAcceptedTerms": false,
- "termsVersion": 0,
- "language": [
- "string"
], - "federated": false,
- "level": "string"
}, - "meter_type": "TRMETER",
- "target": "string",
- "remark": 0,
- "responsible_company": 0,
- "must_be_fixed_at": "string",
- "additional_info": "string",
- "confirmed_at": "string",
- "confirmation_comment": "string",
- "created_at": "string",
- "updated_at": "string",
- "image_folder_id": 0,
- "image_folder_uuid": "string",
- "image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "confirmation_image_folder_id": 0,
- "confirmation_image_folder_uuid": "string",
- "confirmation_image_folder": {
- "project": 0,
- "length": "string",
- "projectUuid": "string",
- "created_at": "string",
- "description": "string",
- "author": "string",
- "parentUuid": "string",
- "permissions": "READABLE",
- "path": "string",
- "notifications": {
- "id": 0,
- "email": "string",
- "pushnotifications": 0
}, - "hasSubFolders": true,
- "newFolderPermission": "string",
- "userPermission": "string",
- "customMeta": {
- "uuid": "string",
- "value": 0
}, - "customMetaUuid": "string",
- "id": 0,
- "uuid": "string",
- "name": "string",
- "type": "string",
- "bookmarked": true,
- "parent": 0
}, - "remark_status": "string"
}
]