Back to Change

An authorization can be brought back into the "Change" status by the "Back to Change" operation. The "Back to Change" operation is available for authorizations in the status "Pended".

When an authorization is in pended status, an addition link is added to the resource representation:

{
 "links": [
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]generic/authorizations/{id}",
      "rel": "self"
    },
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/authorizations/{id}/tochange",
      "rel": "authorization:tochange",
      "httpMethod": "POST"
    }
  ]
}

Calling POST on this link will bring an authorization in the "Change" status. HTTP Status 201 is returned together with a resource representation of the updated authorization.

In the resource representation of an authorization that can’t be changed back to 'change' status, for example: if the authorization is already in change status:

The table below gives an overview:

Table 1. Back to Change link for an Authorization in status:
Status of the authorization Link Resource Available

Entry

No

In Process

No

Pended

Yes

Changed

No

Approved

No

Denied

No

 
{
  "links": [
    {
    "href": "http://[hostName]:[portNumber]/[api-context-root]/generic/authorizations/",
    "rel": "self"
    },
  ]
}

Operation

  • Status of the authorization changes to 'Change'

  • Creates the Authorization status history for this change in the status

  • Creates Authorization pend history records for this change in the status for all pend reasons that are attached to the Authorization

    • The resolved by and resolved date time attributes of the Authorization pend history records of the most recent authorization status history for status pended are not set (because they are not yet resolved)

  • Pend reasons that are attached to the Authorization will remain on the Authorization.

  • The system checks the Pend Resolution rights on the process step in which the Authorization is pended

  • If Pend Resolution Access Restriction is specified on the process step in which the Authorization is pended

    • Perform the operation only if the users has the Access Restriction Grant (with Update rights) for the Pend Resolution Access Restriction that is specified on the process step in which the Authorization is pended

    • The process step in which the Authorization is pended is the earliest (with the low[source,text,subs="verbatim,attributes"] ----est sequence number) process step that is referenced by one or more Authorization pend reasons

  • In case if the user does not have access to resolve pends for the step in which the Authorization has pended; the system returns '403 Forbidden'.

Authorization

This operation is protected by access restriction "authorizations.tochange IP". Read grant must also be given to the access restriction "authorizations API".

Response Message

Failure

Table 2. Response Messages
Response Description

AUT-IP-AUTO-001

Authorization id {id} is unknown

AUT-IP-AUTI-025

Authorizations cannot be brought back to Change status from status {status}

Please refer to Response Messages for more details.