Checkout Document
get
/document/checkoutDocument
Checkout Document objects from the database.
Request
Query Parameters
-
DocumentObjectId(required): string
DocumentId to loadExample:
12345
-
DownloadType(required): string
DownloadType is required to download specific Document response type, By default BOTH is enabled(Supported values - ATTACHMENT_ONLY,BOTH,RESPONSE_JSON_ONLY)Example:
BOTH
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- multipart/mixed
- application/json
200 Response
OK.
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
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.