Jump to

• Request
• Response

Create Zip for the List of Files under a Scope

post

/api/restapi/document/file/zip/files

Send a request to this endpoint to create a zip creation request for the specified files under a given scope.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityZipRequest

Type: object

Title: ApiEntityZipRequest

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

• scope, scopeId
• scope, scopeCode, workspaceId
• scope, scopeCode, workspaceCode

Show Source

• documents: array documents
  The list of files and folders.
• includeUnscannedFiles: boolean
  This parameter is used to determine whether to include the files that are un-scanned or not.
• scope: string
  Allowed Values: [ "genericPortfolio", "project", "idea", "program" ]

  The object name of the context the file is created in.
• scopeCode: string
  Maximum Length: 255

  The user-specified identifier of the object of the context the file is created in.
• scopeId: integer (int64)
  The system-generated identifier of the object of the context the file is created in.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityZipRequest",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of the object of the context the file is created in.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name of the context the file is created in.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "genericPortfolio",
                "project",
                "idea",
                "program"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The user-specified identifier of the object of the context the file is created in.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documents":{
            "type":"array",
            "description":"The list of files and folders.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/DocumentIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "includeUnscannedFiles":{
            "type":"boolean",
            "description":"This parameter is used to determine whether to include the files that are un-scanned or not.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"This entity represents a ZipRequest object, a unique ZipRequest object can be identified by the following combinations of the fields.<ul><li>scope, scopeId</li><li>scope, scopeCode, workspaceId</li><li>scope, scopeCode, workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : documents

Type: array

The list of files and folders.

Show Source

• Array of: object DocumentIdentifier
  Title: DocumentIdentifier

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

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

{
    "type":"array",
    "description":"The list of files and folders.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/DocumentIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : DocumentIdentifier

Type: object

Title: DocumentIdentifier

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

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

Show Source

• id: string
  The system-generated identifier of the file, folder, or template.
• name: string
  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: string
  The system-generated identifier of the parent object of the file or folder.
• scope: string
  Allowed Values: [ "genericPortfolio", "project", "idea", "program" ]

  The object name of the context the file or folder is created in.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The system-specified identifier of a workspace.

{
    "title":"DocumentIdentifier",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the file, folder, or template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"string",
            "description":"The system-generated identifier of the file, folder, or template.",
            "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",
                "idea",
                "program"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"string",
            "description":"The system-generated identifier of the parent object of the file or folder.",
            "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"
            ]
        }
    },
    "description":"This entity represents a dentifier object, a unique dentifier 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
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityZipRequestDetails

Type: object

Title: ApiEntityZipRequestDetails

Show Source

• errorDetails: errorDetails
  The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.
• expiresAt: string (date-time)
  The date and time the file will be available for downloading. Once this time has passed, the file is no longer available and will need to be downloaded again.
• zipRequestId: integer (int64)
  The system-generated identifier of a zip request created.
• zipRequestStatus: string
  Allowed Values: [ "IN_QUEUE", "ZIP_CREATION_IN_PROGRESS", "ZIP_CREATION_IN_PROGRESS_WITH_WARNING", "READY_FOR_DOWNLOAD", "REQUEST_FAILED", "REQUEST_FAILED_NO_FILES", "REQUEST_EXPIRED" ]

  The status of the file zip request process.

  • IN_QUEUE: The zip requests is waiting to be processed.
  • ZIP_CREATION_IN_PROGRESS: The creation of the zip folder is in progress.
  • ZIP_CREATION_IN_PROGRESS_WITH_WARNING : The creation of the zip folder is in process, but some files could not be included.
  • READY_FOR_DOWNLOAD: The creation of the zip folder has completed and is ready for download.
  • REQUEST_FAILED: An error occured during the zip folder creation and couldn't complete the request
  • REQUEST_FAILED_NO_FILES: The zip folder could not be created. There are no files to add to the .zip folder
  • REQUEST_EXPIRED: The zip folder was created but is deleted after 24 hours.

{
    "title":"ApiEntityZipRequestDetails",
    "type":"object",
    "properties":{
        "zipRequestId":{
            "type":"integer",
            "description":"The system-generated identifier of a zip request created.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "zipRequestStatus":{
            "type":"string",
            "description":"The status of the file zip request process. <ul> <li> <b>IN_QUEUE:</b> The zip requests is waiting to be processed. </li><li><b>ZIP_CREATION_IN_PROGRESS:</b> The creation of the zip folder is in progress. </li><li><b>ZIP_CREATION_IN_PROGRESS_WITH_WARNING :</b> The creation of the zip folder is in process, but some files could not be included. </li><li><b>READY_FOR_DOWNLOAD:</b> The creation of the zip folder has completed and is ready for download. </li><li><b>REQUEST_FAILED:</b> An error occured during the zip folder creation and couldn't complete the request </li><li><b>REQUEST_FAILED_NO_FILES:</b> The zip folder could not be created.  There are no files to add to the .zip folder </li><li><b>REQUEST_EXPIRED:</b> The zip folder was created but is deleted after 24 hours. </li></ul>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_QUEUE",
                "ZIP_CREATION_IN_PROGRESS",
                "ZIP_CREATION_IN_PROGRESS_WITH_WARNING",
                "READY_FOR_DOWNLOAD",
                "REQUEST_FAILED",
                "REQUEST_FAILED_NO_FILES",
                "REQUEST_EXPIRED"
            ]
        },
        "expiresAt":{
            "type":"string",
            "description":"The date and time the file will be available for downloading. Once this time has passed, the file is no longer available and will need to be downloaded again.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "errorDetails":{
            "description":"The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityZipRequestErrorDetails"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : errorDetails

The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.

Match All

Show Source

• object ApiEntityZipRequestErrorDetails
  Title: ApiEntityZipRequestErrorDetails

{
    "description":"The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityZipRequestErrorDetails"
        }
    ]
}

Nested Schema : ApiEntityZipRequestErrorDetails

Type: object

Title: ApiEntityZipRequestErrorDetails

Show Source

• cause: string
  Maximum Length: 4000

  The cause for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.
• message: string
  This field represents the error message when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.
• resolution: string
  The resolution for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityZipRequestErrorDetails",
    "type":"object",
    "properties":{
        "cause":{
            "maxLength":"4000",
            "type":"string",
            "description":"The cause for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"This field represents the error message when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resolution":{
            "type":"string",
            "description":"The resolution for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

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

Back to Top