Jump to

• Request
• Response

Update a File

put

/api/restapi/document/file

Send a request to this endpoint to update a file.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityDocumentInput

Type: object

Title: ApiEntityDocumentInput

This entity represents a Document object, a unique Document object can be identified by the following combinations of the fields.

• id
• parentId, name
• parentFolderPath, name, scope, workspaceId
• parentFolderPath, name, scope, workspaceCode

Show Source

• addressLine1: string
  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Maximum Length: 200

  The second line of the address associated with a file.
• annotationCount: object annotationCount
  Read Only: true

  Deprecated. As of 23.11.
  The total number of annotations created for the file.
• author: string
  Maximum Length: 200

  Deprecated. As of 23.11.
  The system-generated identifier of a user assigned as an owner of this object.
• checkedOut: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether or not the file is checked-out.
• checkedOutBy: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The user that checked out a file.
• checkedOutDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date the user checked out the file.
• checkedOutUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier of a user.
• cityName: string
  Maximum Length: 200

  The name of the city associated with a file.
• codeValuesDocument: array codeValuesDocument
  The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.
• comment: string
  Maximum Length: 4000

  Additional notes about the file.
• countryCode: string
  Maximum Length: 3

  The code of the country associated with a file.
• createDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  This field represent the date the record is created.
• createUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who created the record.
• description: string
  Maximum Length: 4000

  Additional information about the file.
• documentConfiguredFields: array documentConfiguredFields
  Unique Items Required: true

  The list of configured fields for a file.
• hasChildren: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether or not the folder has children.
• id: string
  Maximum Length: 18

  The system-generated identifier of the file, folder, or template.
• isActualRoot: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether or not this folder is the root node in a folder structure.
• latitude: number (double)
  The latitude of the location associated with the file.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• locationName: string
  Maximum Length: 255

  The name of the location associated with the file.
• longitude: number (double)
  The longitude of the location associated with the file.
• mimeType: string
  Read Only: true

  Maximum Length: 80

  Deprecated. As of 23.11.
  The type of a file.
• name(required): string
  Maximum Length: 255

  The name of the file, folder, or template.
• parentFolderPath: string
  The path of the parent folder from it's root folder.
  The field is non-persistable and thus maximum length is not applicable.
• parentId(required): string
  Maximum Length: 18

  The system-generated identifier of the parent object of the file or folder.
• parentType: string
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 23.11.
  The context in which the file is added.
• postalCode: string
  Maximum Length: 20

  The postal code of the location associated with the file.
• scanStatus: string
  Read Only: true

  Allowed Values: [ "SCAN_PENDING", "SCAN_CLEARED", "SCAN_FAILED", "SCAN_INCONCLUSIVE", "SCAN_ERROR", "SCAN_DISABLED" ]

  Deprecated. As of 23.11.
  Virus scan status of the current version of a file. A virus scan could return one of the following virus statuses:

  • SCAN_FAILED : A virus was found for this file.
  • SCAN_CLEARED : Virus scan was run and found the file to not contain viruses.
  • SCAN_DISABLED : File has not been scanned for viruses because scanning at has been disabled for the data center.
  • SCAN_INCONCLUSIVE :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.
  • SCAN_PENDING : Virus scan is in progress for this file.
  • SCAN_ERROR : There was an error while scanning the file for viruses. Try to scan the file again.
• scope: string
  Allowed Values: [ "genericPortfolio", "project", "template", "idea", "program", "strategy" ]

  The object name of the context the file or folder is created in.
• scopeId: integer (int64)
  The system-generated identifier of the object of the context the file or folder is created in.
• size: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The current size of the file in bytes.
• stateCode: string
  Maximum Length: 20

  The code of the state of the location associated with the file.
• stateName: string
  Maximum Length: 200

  The name of the state of the location associated with the file.
• type: string
  Read Only: true

  Allowed Values: [ "FOLDER", "DOCUMENT", "XLSX", "DOCX", "DOC", "XLS" ]

  Deprecated. As of 23.11.
  Indicates whether this is a file or a folder.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• updateUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who last modified the record.
• url: string
  Read Only: true

  Deprecated. As of 23.11.
  The WebDAV URL for the file or folder.
  It allows you to configure file management extensions to map an object to your machine.
  Maximum Length: 2,147,483,647
• version: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The current version of the file.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The system-specified identifier of a workspace.

{
    "title":"ApiEntityDocumentInput",
    "required":[
        "name",
        "parentId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the file, folder, or template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the file, folder, or template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether this is a file or a folder.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FOLDER",
                "DOCUMENT",
                "XLSX",
                "DOCX",
                "DOC",
                "XLS"
            ]
        },
        "size":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current size of the file in bytes.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of the object of the context the file or folder is created in.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "comment":{
            "maxLength":"4000",
            "type":"string",
            "description":"Additional notes about the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "version":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current version of the file.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information about the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "url":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The WebDAV URL for the file or folder.<br/>It allows you to configure file management extensions to map an object to your machine.<br/>Maximum Length: 2,147,483,647",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name of the context the file or folder is created in.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "genericPortfolio",
                "project",
                "template",
                "idea",
                "program",
                "strategy"
            ]
        },
        "mimeType":{
            "maxLength":"80",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The type of a file.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who last modified the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the date the record is created.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who created the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "locationName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the location associated with the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "annotationCount":{
            "type":"object",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total number of annotations created for the file.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"PRIMAVERA_DB_DOCUMENT_KEY:document_annotation_count_description",
                "readOnly":true
            }
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the parent object of the file or folder.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine1":{
            "maxLength":"200",
            "type":"string",
            "description":"The first line of the address of a location.<br/>This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":"200",
            "type":"string",
            "description":"The second line of the address associated with a file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the city associated with a file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the state of the location associated with the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code of the location associated with the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The code of the country associated with a file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "latitude":{
            "type":"number",
            "description":"The latitude of the location associated with the file.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "longitude":{
            "type":"number",
            "description":"The longitude of the location associated with the file.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "stateCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The code of the state of the location associated with the file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "checkedOutDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date the user checked out the file.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "checkedOutUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a user.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hasChildren":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the folder has children.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isActualRoot":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not this folder is the root node in a folder structure.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "author":{
            "maxLength":"200",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a user assigned as an owner of this object.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "checkedOutBy":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The user that checked out a file.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "checkedOut":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the file is checked-out.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "documentConfiguredFields":{
            "uniqueItems":true,
            "type":"array",
            "description":"The list of configured fields for a file. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityDocumentConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValuesDocument":{
            "type":"array",
            "description":"The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueDocumentInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scanStatus":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Virus scan status of the current version of a file. A virus scan could return one of the following virus statuses: <ul><li><b>SCAN_FAILED</b> : A virus was found for this file.</li><li><b>SCAN_CLEARED</b> : Virus scan was run and found the file to not contain viruses.</li><li><b>SCAN_DISABLED</b> : File has not been scanned for viruses because scanning at has been disabled for the data center.</li><li><b>SCAN_INCONCLUSIVE</b> :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.</li><li><b>SCAN_PENDING</b> : Virus scan is in progress for this file.</li><li><b>SCAN_ERROR</b> : There was an error while scanning the file for viruses. Try to scan the file again.</li></ul>",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SCAN_PENDING",
                "SCAN_CLEARED",
                "SCAN_FAILED",
                "SCAN_INCONCLUSIVE",
                "SCAN_ERROR",
                "SCAN_DISABLED"
            ]
        },
        "parentType":{
            "maxLength":"60",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The context in which the file is added.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentFolderPath":{
            "type":"string",
            "description":"The path of the parent folder from it's root folder.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Document object, a unique Document object can be identified by the following combinations of the fields.<ul><li>id</li><li>parentId, name</li><li>parentFolderPath, name, scope, workspaceId</li><li>parentFolderPath, name, scope, workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : annotationCount

Type: object

Read Only: true

Deprecated. As of 23.11.
The total number of annotations created for the file.

Nested Schema : codeValuesDocument

Type: array

The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueDocumentInput
  Title: ApiEntityCodeValueDocumentInput

  This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.

  • codeValueDocumentId
  • codeValueId
  • codeValueCode,codeTypeId
  • codeValueCode,codeTypeCode
  • codeTypeCode,codeValueCode,parentId
  • codeValueCode,codeTypeId,parentId

{
    "type":"array",
    "description":"The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueDocumentInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : documentConfiguredFields

Type: array

Unique Items Required: true

The list of configured fields for a file.

Show Source

• Array of: object ApiEntityDocumentConfiguredFieldValueInput
  Title: ApiEntityDocumentConfiguredFieldValueInput

  This entity represents a DocumentConfiguredFieldValue object, a unique DocumentConfiguredFieldValue object can be identified by the following combinations of the fields.

  • documentConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "uniqueItems":true,
    "type":"array",
    "description":"The list of configured fields for a file. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityDocumentConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueDocumentInput

Type: object

Title: ApiEntityCodeValueDocumentInput

This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.

• codeValueDocumentId
• codeValueId
• codeValueCode,codeTypeId
• codeValueCode,codeTypeCode
• codeTypeCode,codeValueCode,parentId
• codeValueCode,codeTypeId,parentId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of a code or value.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueDocumentId: integer (int64)
  The system-generated identifier of a code value document assignment.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• createDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  This field represent the date the record is created.
• createUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who created the record.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• sequenceNumber: integer (int32)
  Deprecated. As of 23.11.
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• updateUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who last modified the record.

{
    "title":"ApiEntityCodeValueDocumentInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who last modified the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the date the record is created.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who created the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueDocumentId":{
            "type":"integer",
            "description":"The system-generated identifier of a code value document assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of a code or value.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.<ul><li>codeValueDocumentId</li><li>codeValueId</li><li>codeValueCode,codeTypeId</li><li>codeValueCode,codeTypeCode</li><li>codeTypeCode,codeValueCode,parentId</li><li>codeValueCode,codeTypeId,parentId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityDocumentConfiguredFieldValueInput

Type: object

Title: ApiEntityDocumentConfiguredFieldValueInput

This entity represents a DocumentConfiguredFieldValue object, a unique DocumentConfiguredFieldValue object can be identified by the following combinations of the fields.

• documentConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• createDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  This field represent the date the record is created.
• createUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who created the record.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• documentConfiguredFieldValueId: integer (int64)
  The unique identifier for the File Configured Field.
• documentId: integer (int64)
  The system-generated identifier of the file, folder, or template.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 255

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• updateUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  This field represent the user name of the user who last modified the record.

{
    "title":"ApiEntityDocumentConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who last modified the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the date the record is created.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This field represent the user name of the user who created the record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":"255",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documentId":{
            "type":"integer",
            "description":"The system-generated identifier of the file, folder, or template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "documentConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the File Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a DocumentConfiguredFieldValue object, a unique DocumentConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>documentConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a file

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Document service. Verify the request contains valid data, then resubmit the request.

Back to Top