List Documents

Lists all documents based on filter criteria.

get

Path parameters

productIdstringRequired

Responses

200

OK

application/json

get

/public/v1/catalog/products/{productId}/documents

HTTPcURLJavaScriptPython

GET /public/v1/catalog/products/{productId}/documents HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {},
        "updated": {}
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "type": "text",
      "description": "text",
      "status": "text",
      "filename": "text",
      "size": 1,
      "contentType": "text",
      "url": "text",
      "language": "text",
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      }
    }
  ]
}