API Docs

__METHOD= POST . __PATH= /almaws/v1/users/{user_id}/requests/{request_id} .

Action on a request

This API performs an action on a request. Currently supported: moving digitization requests to their next step.

Resource URL

POST /almaws/v1/users/{user_id}/requests/{request_id}

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user
request_idxs:stringA unique identifier of the request that should be canceled.

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringOptional.The operation to be performed on the request. Mandatory. Currently only next_step is supported.
release_itemxs:stringOptional. Default: falseBoolean flag for indicating whether to release the item from the request.

Body Parameters

None

Output

This method returns a Request object. See doc

Possible Error Codes

CodeMessage
401652General Error - An error has occurred while processing the request.
401907Failed to find a request for the given request ID.
402205Input parameter X (Y) is not numeric.
401932Request X is not a Digitization request
401933Cannot move forward in workflow. Request ID: X, Step: Y
401934Move digitization request to next step in workflow has failed. Request ID: X
401666X parameter is not valid.