All pages
Powered by GitBook
1 of 1

Loading...

List enrollments

get
Responses
200

OK

application/json
offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
idstringOptional
namestringOptional
idstringOptional
namestringOptional
statusstring · enumOptionalPossible values:
applicableTostring · enumOptionalPossible values:
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
namestringOptional
shortDescriptionstring · nullableOptional
longDescriptionstring · nullableOptional
operationsstring · nullableOptional
defaultErpItemstring · nullableOptional
websitestringOptional
iconstringOptional
statusstringOptional
idstringOptional
iconstring · nullableOptional
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
namestring · min: 1 · max: 500Required
productOrderingbooleanOptional
enabledbooleanOptional
namestring · nullableOptional
labelstring · nullableOptional
itemSelectionbooleanOptional
orderQueueChangesbooleanOptional
purchaseOrderDraftbooleanOptional
purchaseOrderQueryingbooleanOptional
changeOrderDraftbooleanOptional
configurationOrderDraftbooleanOptional
terminationOrderbooleanOptional
productRequestbooleanOptional
enabledbooleanOptional
typestring · nullableOptional
enabledbooleanOptional
modestring · enum · nullableOptionalPossible values:
itemCountinteger · int32Optional
ordersPlacedCountinteger · int32Optional
agreementCountinteger · int32Optional
subscriptionCountinteger · int32Optional
requestCountinteger · int32Optional
applicableTostring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
idstringOptional
iconstring · nullableOptional
namestring · nullableOptional
idstringOptional
iconstring · nullableOptional
namestring · nullableOptional
externalIdstring · nullableOptional
clientbooleanOptional
partnerbooleanOptional
statusstring · enumOptionalPossible values:
notesstring · nullableOptional
idstring · nullableOptional
messagestring · min: 1 · max: 4000Required
parametersany · nullableOptional
idstringOptional
iconstring · nullableOptional
namestringOptional
idstringOptional
externalIdstring · nullableOptional
namestringOptional
typestring · enumOptionalPossible values:
phasestring · enumOptionalPossible values:
idstring · nullableOptional
messagestring · min: 1 · max: 4000Required
parametersany · nullableOptional
hiddenboolean · nullableOptional
readonlyboolean · nullableOptional
requiredboolean · nullableOptional
displayValuestringOptional
valueany · nullableOptional
idstringOptional
externalIdstring · nullableOptional
namestringOptional
typestring · enumOptionalPossible values:
phasestring · enumOptionalPossible values:
idstring · nullableOptional
messagestring · min: 1 · max: 4000Required
parametersany · nullableOptional
hiddenboolean · nullableOptional
readonlyboolean · nullableOptional
requiredboolean · nullableOptional
displayValuestringOptional
valueany · nullableOptional
idstring · nullableOptional
messagestring · min: 1 · max: 4000Required
parametersany · nullableOptional
idstringOptional
namestringOptional
typestring · enumOptionalPossible values:
get/public/v1/program/enrollments
GET /public/v1/program/enrollments 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": {},
        "processing": {},
        "querying": {},
        "completed": {},
        "failed": {}
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "certificate": {
        "id": "text",
        "name": "text"
      },
      "program": {
        "id": "text",
        "name": "text",
        "status": "text",
        "applicableTo": "text",
        "products": [
          "[Circular Reference]"
        ]
      },
      "applicableTo": "text",
      "type": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "eligibility": {
        "client": true,
        "partner": true
      },
      "status": "text",
      "notes": "text",
      "statusNotes": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "assignee": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "parameters": {
        "ordering": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "hidden": true,
              "readonly": true,
              "required": true
            },
            "displayValue": "text",
            "value": null
          }
        ],
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "hidden": true,
              "readonly": true,
              "required": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "template": {
        "id": "text",
        "name": "text",
        "type": "text"
      }
    }
  ]
}