List Documents

Lists all documents based on filter criteria.

get

Path parameters

programIdstringRequired

Responses

200

OK

application/json

get

/public/v1/program/programs/{programId}/documents

HTTPcURLJavaScriptPython

GET /public/v1/program/programs/{programId}/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",
      "program": {
        "id": "text",
        "name": "text",
        "status": "text",
        "applicableTo": "text",
        "products": [
          "[Circular Reference]"
        ]
      }
    }
  ]
}