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.
• 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.
• 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.
• id: string
  Maximum Length: 18

  The system-generated identifier of the file, folder, or template.
• latitude: number (double)
  The latitude of the location associated with the file.
• 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.
• 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.
• postalCode: string
  Maximum Length: 20

  The postal code of the location associated with the file.
• 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.
• 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.
• 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":{
        "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"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "description":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional information about the file.",
            "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"
            ]
        },
        "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"
            ]
        },
        "longitude":{
            "type":"number",
            "description":"The longitude of the location associated with the file.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "latitude":{
            "type":"number",
            "description":"The latitude 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"
            ]
        },
        "parentId":{
            "maxLength":18,
            "type":"string",
            "description":"The system-generated identifier of the parent object of the file or folder.",
            "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"
            ]
        }
    },
    "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 : 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.
• 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.
• 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.

{
    "title":"ApiEntityCodeValueDocumentInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueDocumentId":{
            "type":"integer",
            "description":"The system-generated identifier of a code value document assignment.",
            "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"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "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"
            ]
        },
        "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"
            ]
        }
    },
    "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.
• 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.
• 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.

{
    "title":"ApiEntityDocumentConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "documentConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the File Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "documentId":{
            "type":"integer",
            "description":"The system-generated identifier of the file, folder, or template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":255,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "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"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 by Assigning Multiple Code Values Using IDs Update a File by Assigning Code Values Using Codes Update a File by Assigning Hierarchical Code Values Using Codes Update a File that includes Multiple Configured Field Values including Text, Number, and Date Update a File by Assigning Code Values Using IDs Update a file Update a File that include Configured Field Text

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