Welcome to Keepeek Help Center

Articles in this section

See more

Classification validation requests

Allows you to request an element classification. NB: it is not possible to delete a classification request. This relation targets classification validation requests.

Create a classification validation request

POST /api/dam/classification-validation-requests

  {
  "mediaIds": [
    37,
    22,
    50411
  ],
  "reason": "can you classify these elements?",
  "responsibleIds": [
    8,
    91
  ]
}

Request body must contain the following attributes:

  • mediaIds: An array of integers containing the identifiers of the requested elements. They must be in "import" status and you must have the rights to them.

Request body can contain the following attributes:

  • reason: A string containing the request reason that will be read by the validation responsible.
  • responsibleIds: An array of integers containing the identifiers of the users who will receive a notification about the request and be able to validate it. If this information is not valued, the classification managers defined at the level of the applicant's profile will be used.

If the classification validation request is created with success, the HTTP status of the response will be 201. It is then possible to get the location of the newly created resource in the Location HTTP response header.

Get all classification validation requests

GET /api/dam/classification-validation-requests

Response body

{
  "_links": {
    "self": {
      "href": "http://XXX/api/dam/classification-validation-requests?page=1&size=20"
    },
    "curies": [
      {
        "name": "kpk",
        "href": "http://XXX/api/doc/rels/{rel}",
        "templated": true
      }
    ]
  },
  "_embedded": {
    "classification-validation-request": [
      {
        "id": XX,
        "status": "BEING_PROCESSED",
        "reason": "XXX",
        "_links": {
          "self": {
            "href": "http://XXX/api/dam/classification-validation-requests/XX"
          }
        }
      },
      {
        "id": XX,
        "status": "WAITING",
        "reason": "XXX",
        "_links": {
          "self": {
            "href": "http://XXX/api/dam/classification-validation-requests/XX"
          }
        }
      }
    ]
  },
  "totalCount": 2
}

The status are as follows:

  • "WAITING": the request is awaiting processing.
  • "BEING_PROCESSED": the request is being processed.
  • "COMPLETED": the request is completed.

NB: completed classification requests are not displayed for the user who made the request

Get specific classification validation request

GET /api/dam/classification-validation-requests/1

Response body

{
  "id": XX,
  "mediaIds": [
    XXX,
    XXX,
    XXX
  ],
  "status": "BEING_PROCESSED",
  "userId": XX,
  "responsibleIds": [
    XX,
    XX
  ],
  "reason": "XXX",
  "_links": {
    "kpk:user": {
      "href": "http://XXX/api/dam/users/XX"
    },
    "curies": [
      {
        "name": "kpk",
        "href": "http://XXX/api/doc/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "http://XXX/api/dam/classification-validation-requests/XX"
    }
  },
  "_embedded": {
    "creationUser": {
      "id": XX,
      "lastName": "Test",
      "firstName": "Test",
      "email": "XXX@XXX",
      "status": X
    },
    "responsibleUser": [
      {
        "id": X,
        "lastName": "Test2",
        "firstName": "Test2",
        "email": "XXX@XXX",
        "status": X
      },
      {
        "id": X,
        "lastName": "Test3",
        "firstName": "Test3",
        "email": "XXX@XXX",
        "status": X
      }
    ]
  }
}

The status are as follows:

  • "WAITING": the request is awaiting processing.
  • "BEING_PROCESSED": the request is being processed.
  • "COMPLETED": the request is completed.

NB: completed classification requests are not displayed for the user who made the request

4.71.0

Related articles