Update Content Request State

To change the state of a specified content request, the client must send a POST request to: /aims/rs/scim/v2/ContentRequest/<id>/<action>.

The supported actions are: “approve”and “retry”. The request body must be a form containing the reason.

The possible HTTP status codes returned are:

  • 200: OK

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

  • 404: Not Found

Example request:

Copy
POST /aims/rs/scim/v2/ContentRequest/16548
Host: cms.mycompany.com
Accept: application/scim+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer h480djs93hd8
Content-Length: 11

reason=LOST

Example response:

Copy
HTTP/1.1 200 OK
Content-Type: application/scim+json
Location: https://cms.mycompany.com/aims/rs/scim/v2/ContentRequest/16548

{
  "id": "string",
  "meta": {
    "created": "2024-09-27T12:31:06.878Z",
    "lastModified": "2024-09-27T12:31:06.878Z",
    "location": "https://cms.mycompany.com/aims/rs/scim/v2/ContentRequest/16548",
    "resourceType": "/_KSpxmmsPEPw8rdjkYzd42Sbiu1y7"
  },
  "type": "update",
  "parameters": [
    {
      "id": "string",
      "value": "string",
      "type": "string",
      "encoding": "none"
    }
  ],
  "target": {
    "devicePolicy": {
      "\\$ref": "string",
      "value": "C2300 - Authentication only",
      "display": "string",
      "type": "string"
    },
    "device": {
      "\\$ref": "string",
      "value": "OP_2.047900503004400044309",
      "display": "string",
      "type": "string"
    }
  },
  "reason": "damaged",
  "wallet": {
    "\\$ref": "string",
    "value": "c28941b2-44f7-476c-abb9-63ef75a699ad",
    "display": "string",
    "type": "string"
  },
  "status": "requested",
  "schemas": [
    "urn:hid:scim:api:cms:1.0:ContentRequest"
  ],
  "urn:hid:scim:api:cms:1.0:DeviceUpdate": {
    "credentials": [
      {
        "id": "string",
        "name": "string",
        "schema": "string",
        "action": "none",
        "reason": "unchanged",
        "status": "string",
        "recovery": {
          "source": "credential",
          "credential": {
            "\\$ref": "string",
            "value": "string",
            "display": "string",
            "type": "string"
          },
          "version": 0
        }
      }
    ]
  }
}