Get Documents

This API retrieves documents associated with the document ID provided in the request.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: document
  title: Document
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json  
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    scopes:
      Fulfillment_Returns: "Read/Write access to Orders, Items, RMAs, Inventory,ASN  and 1.1\tInbound Shipments objects"
    authorizationUrl: 'https://<.........................>/fsc/oauth2/authorize'
    tokenUrl: 'https://<.........................>/fsc/oauth2/token'    
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Id: []
    oauth2:
      - Fulfillment_Returns
    Client_Secret: []
x-ibm-configuration:
  testable: true
  enforced: true
paths:
  /documents/{documentId}:
   get:
      responses:
        '200':
          description: 200 OK
      parameters:
        - name: accessToken
          type: string
          required: false
          in: header
          description: 'Enter AccessToken, it is mandatory in case of basic authentication.'
        - name: documentId
          type: string
          required: true
          in: path
          description: Enter document id
      description: This API retrieves documents associated with the document ID provided in the request.
      security:
        - client_secret: []
          Client_Id: []
        - oauth2:
            - Fulfillment_Returns
      summary: Get Documents
      consumes:
        - application/json
      produces:
        - application/json

      

Sample Response

Success Response

         

{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": true,
  "documents": [
    {
      "id": "189101901",
    "content": "<…BASE64 CONTENT…>",
      " contentType": "pdf"
    }
  ]
}


      

Sample Error Response

Error Response

         


{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": false,
  "errors": [
    {
      "code": "ERR-SYS-0001",
      "description": "Your request cannot be processed due to a system error."
    }
  ]
}



      

OAuth 2.0

Response Attribute

HTTP Status Code

Error Code