Create a Folder

post

/api/restapi/document/folder

Send a request to this endpoint to create a folder.

Request

There are no request parameters for this operation.

Supported Media Types
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
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
  • 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
Nested Schema : documentConfiguredFields
Type: array
Unique Items Required: true
The list of configured fields for a file.
Show Source
  • 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
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
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
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • This holds values for Date type configured fields.
  • The unique identifier for the File Configured Field.
  • The system-generated identifier of the file, folder, or template.
  • 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.
  • Maximum Length: 255
    This holds values for Boolean, List and Text type configured fields.
Examples

Back to Top

Response

Supported Media Types

201 Response

The object was successfully created.
Body ()
Root Schema : ApiEntityDocument
Type: object
Title: ApiEntityDocument
Show Source
Nested Schema : annotationCount
Type: object
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
  • ApiEntityCodeValueDocument
    Title: ApiEntityCodeValueDocument
    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
    • codeValueCode,codeTypeCode,projectCode
Nested Schema : documentConfiguredFields
Type: array
Unique Items Required: true
The list of configured fields for a file.
Show Source
Nested Schema : ApiEntityCodeValueDocument
Type: object
Title: ApiEntityCodeValueDocument
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
  • codeValueCode,codeTypeCode,projectCode
Show Source
Nested Schema : ApiEntityDocumentConfiguredFieldValue
Type: object
Title: ApiEntityDocumentConfiguredFieldValue
Show Source

400 Response

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