Jump to

• Request
• Response
• Examples

Upload document

post

/documentManagement/v1/{documentManagementSystemId}/documents

This operation uploads the file to the underlying DMS/CMS.

Request

Path Parameters

• documentManagementSystemId(required): string
  Unique identifier for DMS/CMS as configured in the CXIF routing GKR criteria

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file(required): string (binary)
• folderData(required): object folderData

{
    "type":"object",
    "required":[
        "folderData",
        "file"
    ],
    "properties":{
        "folderData":{
            "type":"object",
            "required":[
                "folderId"
            ],
            "properties":{
                "folderId":{
                    "type":"string",
                    "example":"DB1C5AF480FFE61C588027A8T000000000010000331"
                }
            }
        },
        "file":{
            "$ref":"#/components/schemas/FileContent"
        }
    }
}

Nested Schema : folderData

Type: object

Show Source

• folderId(required): string
  Example: DB1C5AF480FFE61C588027A8T000000000010000331

{
    "type":"object",
    "required":[
        "folderId"
    ],
    "properties":{
        "folderId":{
            "type":"string",
            "example":"DB1C5AF480FFE61C588027A8T000000000010000331"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Document uploaded successfully

Body ()

Root Schema : DocumentUploadResponseBody

Type: object

Show Source

• createdBy: string
  Name of the user who created the document

  Example: User_Name
• createdWhen: string (date-time)
  Date of document creation

  Example: 2014-02-21T21:32:37Z
• failureReason: string
  Example: File type not supported
• folderId: string
  ID of the folder

  Example: DB1C5AF480FFE61C588027A8T000000000010000331
• href: string
  Path to the file reachable via RMS

  Example: /documentManagement/v1/ocm-1/documents/DB1C5AF480FFE61C588027A8T000000000010000331/data?folderId=123
• id: string
  ID of the document

  Example: DB1C5AF480FFE61C588027A8T0000000000100000001
• name: string
  ID of the folder

  Example: Contracts.pdf
• updatedBy: string
  Name of the user who updated the document

  Example: User_Name
• updatedWhen: string (date-time)
  Date of document update

  Example: 2014-02-21T21:32:37Z
• uploadStatus: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]
• version: string
  File version number

  Example: 1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the document",
            "example":"DB1C5AF480FFE61C588027A8T0000000000100000001"
        },
        "folderId":{
            "type":"string",
            "description":"ID of the folder",
            "example":"DB1C5AF480FFE61C588027A8T000000000010000331"
        },
        "name":{
            "type":"string",
            "description":"ID of the folder",
            "example":"Contracts.pdf"
        },
        "createdBy":{
            "type":"string",
            "description":"Name of the user who created the document",
            "example":"User_Name"
        },
        "createdWhen":{
            "type":"string",
            "format":"date-time",
            "description":"Date of document creation",
            "example":"2014-02-21T21:32:37Z"
        },
        "updatedBy":{
            "type":"string",
            "description":"Name of the user who updated the document",
            "example":"User_Name"
        },
        "updatedWhen":{
            "format":"date-time",
            "type":"string",
            "description":"Date of document update",
            "example":"2014-02-21T21:32:37Z"
        },
        "href":{
            "type":"string",
            "description":"Path to the file reachable via RMS",
            "example":"/documentManagement/v1/ocm-1/documents/DB1C5AF480FFE61C588027A8T000000000010000331/data?folderId=123"
        },
        "version":{
            "type":"string",
            "description":"File version number",
            "example":1
        },
        "uploadStatus":{
            "type":"string",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        },
        "failureReason":{
            "type":"string",
            "example":"File type not supported"
        }
    }
}

400 Response

Request validation failed

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Authorization failure. The authorization header is invalid or missing

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Operation is not permitted based on the supplied authorization.

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to upload document by submitting a post request on the REST resource using cURL.

cURL Command

curl --<username:password> --request POST '{FABRIC_HOST}/api/documentManagement/v1/OCM1/documents/' --header 'Authorization: Bearer <access_token>'  --form 'folderData={"folderId" : "FB4CD874EF94CD2CC1B60B72T0000000000100000001"};type=application/json'  --form 'file=@"/C:/Users/user_name/sample_files/test_file.pdf"'

Example of Request Body

The following shows an example of the request body in JSON format.

------------------------------362052356708186529598553--
Content-Disposition: form-data; name="folderData"
Content-Type: application/json

{
"folderId":"FB4CD874EF94CD2CC1B60B72T0000000000100000001"
}

------------------------------362052356708186529598553--
Content-Disposition: form-data; name="file"; filename="Contracts.pdf"
Content-Type: application/pdf
  
<Actual File Content in binary format goes here>
------------------------------362052356708186529598553--

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "id": "DB1C5AF480FFE61C588027A8T0000000000100000001",
  "folderId": "DB1C5AF480FFE61C588027A8T000000000010000331",
  "name": "Contracts.pdf",
  "createdBy": "User_Name",
  "createdWhen": "2014-02-21T21:32:37Z",
  "updatedBy": "User_Name",
  "updatedWhen": "2014-02-21T21:32:37Z",
  "href": "/documentManagement/v1/ocm-1/documents/DB1C5AF480FFE61C588027A8T000000000010000331/data?folderId=123",
  "version": "1"
}

Back to Top