POST http://localhost:8080/midpoint/ws/rest/tasks/{oid}/suspend
Task Specific Operations
Description
A set of operations which are specific for objects of the "Task" type residing on the "tasks" endpoint.
Request
The requests require the usage of HTTP POST. The URI of the request itself depends on the type of operation. There are THREE types of operation requests which are described on this page.
POST http://localhost:8080/midpoint/ws/rest/tasks/{oid}/resume
POST http://localhost:8080/midpoint/ws/rest/tasks/{oid}/run
Headers
Regarding authorization type, the "Basic" Authorization header should be used.
Authorization: Basic {Base64EncodedCredentials}
To specify the provided content type, please use the "Content-Type" header payload in the body:
"Content-Type: application/json"
You might need to specify the accepted type of content in case you are interested in a format different from xml (default):
"Accept: application/json"
Body
The Task specific operations do not need to contain any specific payload data in the body of the request.
Options
No additional option parameters supported for these types of requests.
Response
Error code | Meaning |
---|---|
1xx |
Information. Stay tuned, operation is in progress. |
2xx |
Success. Operation finished successfully. There are two custom codes:
In this two cases, midPoint returns the OperationResult where there details of executed operations can be found. |
3xx |
Redirection or "in progress". This is returned mostly to indicate two cases:
|
4xx |
Client errors. The client has sent request that cannot be processed. This indicates usual situation that are well handled by the midPoint code. Maybe the client request to create conflicting object, delete non-existent object, modification that violates the schema and so on. The OperationResult structure is usually provided in the response to provide more details about the situation. |
5xx |
Server errors. Situations that the server cannot handle and where the cause is unknown. This usually means bugs in the code, insufficient resources such as RAM or disk space, unforeseen failures in the infrastructure and so on. The OperationResult structure might or might not be provided in this case. Some errors are so severe that the structured error information might not be available. |
Status codes and the indication of errors and asynchronous processing applies uniformly to all midPoint web resources (both RESTful and RPC).
Access Authorization
The interface authorization needed for executing this type of request. The authorization is needed to access the specific part of the interface. For more information please see this page.
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#suspendTask
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#resumeTask
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#runTask
Model Authorization
The model authorization for the specific action. This authorization is needed to request/execute the concrete action. The examples are usually quite broad, and the actions can be additionally specified for a more fine-grained authorization. For more information please see this page.
For the "run" task operation please use:
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#runTaskImmediately
For the "suspend" operation please use:
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#suspendTask
For the "resume" operation please use:
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#resumeTask
Examples
In our examples we are authenticating with the credentials, name "administrator" and password "y0uR_P455woR*d" on a localhost instance running on port 8080. |
For some help regarding the REST examples please see this link:
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-v \
-X POST http://localhost:8080/midpoint/ws/rest/tasks/6d13632c-6b75-4a33-9744-ec9523375f6b/suspend
The response is an HTTP 204 code in case of success with a response body.
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-v \
-X POST http://localhost:8080/midpoint/ws/rest/tasks/6d13632c-6b75-4a33-9744-ec9523375f6b/resume
The response is an HTTP 202 code in case of success, without a response body.
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-v \
-X POST http://localhost:8080/midpoint/ws/rest/tasks/6d13632c-6b75-4a33-9744-ec9523375f6b/run
The response is an HTTP 204 code in case of success, without a response body.