Skip to main content

CreateDocumentRequest

Request payload for creating a document

    serialNumber string

    Possible values: [123456789]

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

    description stringrequired

    Possible values: [Document created for the prometha]

    Description of the document.

    fileInfo

    object

    required

    File information for the document.

    isImage boolean

    Possible values: [false]

    Indicates if the file is an image.

    cdnUrl string

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

    CDN URL of the file.

    name string

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

    Name of the file.

    mimeType string

    Possible values: [application/pdf]

    MIME type of the file.

    originalUrl string

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

    Original URL of the file.

    uuid string

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

    UUID of the file.

    annotations object[]

    Annotations associated with the document.

    documentName stringrequired

    Possible values: [Prometha Asset Document-1]

    Name of the document.

    documentTag string[]required

    Tags associated with the document.

    telematicsSerialNumber integerrequired

    Possible values: [6985698563]

    Telematics serial number.

    userName stringrequired

    Possible values: [oem@industrility.com]

    Username of the user creating the document.

    userId stringrequired

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

    ID of the user creating the document.

    isPdf boolean

    Possible values: [true, false]

    Indicates if the document is in PDF format.

    assetId stringrequired

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

    ID of the associated asset.

    avatarImage stringrequired

    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]

    Avatar image associated with the user.

    userAccountId string

    Possible values: [AN-Account1]

    Account ID associated with the user.

    assetName stringrequired

    Possible values: [Asset2k]

    Name of the associated asset.