Jump to

• Request
• Response

Upload Document

post

/document/uploadDocument

Upload new document

Request

Query Parameters

• ActivityObjectId(required): string
  ActivityObjectId

  Example:

  12345

• Description(required): string
  Description
• DocumentCategoryName(required): string
  DocumentCategoryName
• Owner(required): string
  ResourceObjectId

  Example:

  12345

• ProjectObjectId(required): string
  ProjectObjectId

  Example:

  12345

• ReferenceNumber(required): string
  ReferenceNumber
• SecurityPolicy(required): string
  SecurityPolicy
• Title(required): string
  Title

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)
  File Metadata

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"File Metadata",
            "format":"binary"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : DocumentResourceResponse

Type: object

Title: DocumentResourceResponse

DocumentResourceResponse Entity

Show Source

• Author: string
• DocumentCategoryName: string
• DocumentObjectId: string
• ErrorMessage: string
• LastUpdateDate: string
• LastUpdateUser: string
• Owner: string
• ProjectIdName: string
• ProjectObjectId: string
• ReferenceNumber: string
• ReviewStatus: string
• SecurityPolicy: string
• Size: string
• Success: string
• Title: string
• Version: string

{
    "title":"DocumentResourceResponse",
    "type":"object",
    "properties":{
        "Success":{
            "type":"string"
        },
        "DocumentObjectId":{
            "type":"string"
        },
        "Title":{
            "type":"string"
        },
        "SecurityPolicy":{
            "type":"string"
        },
        "Author":{
            "type":"string"
        },
        "Version":{
            "type":"string"
        },
        "Size":{
            "type":"string"
        },
        "LastUpdateUser":{
            "type":"string"
        },
        "LastUpdateDate":{
            "type":"string"
        },
        "ReviewStatus":{
            "type":"string"
        },
        "Owner":{
            "type":"string"
        },
        "DocumentCategoryName":{
            "type":"string"
        },
        "ReferenceNumber":{
            "type":"string"
        },
        "ProjectObjectId":{
            "type":"string"
        },
        "ProjectIdName":{
            "type":"string"
        },
        "ErrorMessage":{
            "type":"string"
        }
    },
    "description":"DocumentResourceResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top