Skip to main content

CreateDocumentRequest

Request payload for creating a document

serialNumberstring

Please enter the serial number of the asset for which you are creating the document

Possible values: [123456789]

descriptionstringrequired

Description of the document.

Possible values: [Document created for the prometha]

fileInfo objectrequired

File information for the document.

isImageboolean

Indicates if the file is an image.

Possible values: [false]

cdnUrlstring

CDN URL of the file.

Possible values: [https://cdn.industrility.com/517d99cf-bd64-4eb3-9382-35c2a6c81348/]

namestring

Name of the file.

Possible values: [Prometha-Industrility Mapping documentation.pdf]

mimeTypestring

MIME type of the file.

Possible values: [application/pdf]

originalUrlstring

Original URL of the file.

Possible values: [https://cdn.industrility.com/517d99cf-bd64-4eb3-9382-35c2a6c81348/]

uuidstring

UUID of the file.

Possible values: [517d99cf-bd64-4eb3-9382-35c2a6c81348]

annotationsobject[]

Annotations associated with the document.

documentNamestringrequired

Name of the document.

Possible values: [Prometha Asset Document-1]

documentTagstring[]required

Tags associated with the document.

telematicsSerialNumberintegerrequired

Telematics serial number.

Possible values: [6985698563]

userNamestringrequired

Username of the user creating the document.

Possible values: [oem@industrility.com]

userIdstringrequired

ID of the user creating the document.

Possible values: [US-oem@industrility.com]

isPdfboolean

Indicates if the document is in PDF format.

Possible values: [true, false]

assetIdstringrequired

ID of the associated asset.

Possible values: [AS-fe72d945-284a-464d-a6f4-d2bc2e488691]

avatarImagestringrequired

Avatar image associated with the user.

Possible values: [avatar-male.png, avatar-male1.png, avatar-male-2.png, avatar-male-3.png, avatar-male-4.png, avatar-female.png, avatar-female-2.png, avatar-female-3.png]

userAccountIdstring

Account ID associated with the user.

Possible values: [AN-Account1]

assetNamestringrequired

Name of the associated asset.

Possible values: [Asset2k]

CreateDocumentRequest
{
  "serialNumber": "123456789",
  "description": "Document created for the prometha",
  "fileInfo": {
    "isImage": false,
    "cdnUrl": "https://cdn.industrility.com/517d99cf-bd64-4eb3-9382-35c2a6c81348/",
    "name": "Prometha-Industrility Mapping documentation.pdf",
    "mimeType": "application/pdf",
    "originalUrl": "https://cdn.industrility.com/517d99cf-bd64-4eb3-9382-35c2a6c81348/",
    "uuid": "517d99cf-bd64-4eb3-9382-35c2a6c81348"
  },
  "annotations": [
    {}
  ],
  "documentName": "Prometha Asset Document-1",
  "documentTag": [
    "string"
  ],
  "telematicsSerialNumber": 6985698563,
  "userName": "oem@industrility.com",
  "userId": "US-oem@industrility.com",
  "isPdf": true,
  "assetId": "AS-fe72d945-284a-464d-a6f4-d2bc2e488691",
  "avatarImage": "avatar-male.png",
  "userAccountId": "AN-Account1",
  "assetName": "Asset2k"
}