Task Service
{ urn:com.soa.admin.service.tasks.jaxrs } TaskService
The TaskService provides access to administration tasks that involve some form of workflow.
GETGet Tasks
Get all tasks in the system, optionally ordered.
Parameters
Name
Type
Description
Model
ordered
query
If not present or true, the returned set of tasks will be ordered.
boolean
features
query
Should only tasks aassociated with features be retrieved?
boolean
filter
query
Task filter. This is a JEXL expression that is applied to each TaskInfo in the result.
string
brief
query
Only include brief information on each task.
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
taskSet
taskSet {
link {
taskInfo {
links( Collection of link )
tasks( Collection of taskInfo )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
taskInfo {
presentationName( string )
description( string )
completed( boolean )
failed( boolean )
required( boolean )
recommended( boolean )
automated( boolean )
failureDetails( string )
repeatable( boolean )
ready( boolean )
name( string )
links( Collection of link )
requires( Collection of string )
}
GET/{id}Get Task Detail
Get detailed information for a specified task.
Request:
GET /admin/tasks/{task} HTTP/1.1"
Accept: application/json
Responses:
- 200 OK, If successful
- 404 Not Found, If the specified task ID is not found
Parameters
Name
Type
Description
Model
id
path
The ID of the task to fetch.
string
brief
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
taskInfo
taskInfo {
link {
presentationName( string )
description( string )
completed( boolean )
failed( boolean )
required( boolean )
recommended( boolean )
automated( boolean )
failureDetails( string )
repeatable( boolean )
ready( boolean )
name( string )
links( Collection of link )
requires( Collection of string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
GET/{id}/stepsGet Steps for a task
Get all step definitions associated with a task.
Request:
GET /admin/tasks/{task}/steps HTTP/1.1
Accept: application/json
Responses:
- 200 OK, If successful
- 404 Not Found, if the specified task cannot be found
Parameters
Name
Type
Description
Model
id
path
The ID of the task.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
stepSet
stepSet {
link {
stepInfo {
propertySet {
propertyMetadata {
option {
links( Collection of link )
steps( Collection of stepInfo )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
stepInfo {
metadata( propertySet )
presentationName( string )
name( string )
description( string )
links( Collection of link )
}
propertySet {
presentationName( string )
children( Collection of propertySet )
name( string )
description( string )
links( Collection of link )
properties( Collection of propertyMetadata )
}
propertyMetadata {
maxItems( int )
presentationName( string )
defaultValue( string )
format( string )
pattern( string )
description( string )
type( string )
collectionFormat( string )
exclusiveMaximum( boolean )
minItems( int )
allowEmptyValue( boolean )
uniqueItems( boolean )
name( string )
options( Collection of option )
maximum( string )
exclusiveMinimum( boolean )
minimum( string )
}
option {
presentationName( string )
description( string )
value( string )
}
GET/jobs/{id}Get Task Job Status
Get the current state of a job associated with a task.
Request:
GET /admin/tasks/{job} HTTP/1.1
Accept: application/json
Responses :
- 200 OK If successful
- 404 Not Found If the specified job ID cannot be found
Response:
200 OK
Content-Type: application/json
Transfer-Encoding: chunked
{
}
Parameters
Name
Type
Description
Model
id
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
executionStatus
executionStatus {
link {
stepStatus {
start( dateTime )
progress( int )
end( dateTime )
links( Collection of link )
status( stepStatus )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
stepStatus {
state( state )
detail( string )
}
DELETE/jobs/{id}Cancel a Task Job
Cancel an outstanding configuration execution job. The task service maintains the state of a task execution sequence in a "job". These jobs hold any values provided to, or set by the steps taken, during execution of a task. By canceling a job, all state for a task and its steps are cleared from the system.
Request:
DELETE /admin/tasks/jobs/{id} HTTP/1.1
Responses:
- 200 OK
- 404 Not Found if job with given ID is not found
Parameters
Name
Type
Description
Model
id
path
string
GET/{id}/steps/{step}Get Step Detail
Get detailed information on a task step.
Request:
GET /admin/tasks/{task}/steps/{step} HTTP/1.1
Accept: application/json
Responses:
- 200 OK, If successful
- 404 Not Found, If the specified task or step is not found
Response:
200 OK Content-Type: application/json Transfer-Encoding: chunked
{
"presentationName": "Manage Container Identity",
"required": true,
"repeatable": true,
"completed": false,
"failed": false,
"recommended": false,
"automated": false,
"name": "com.soa.container.identity",
"links": [
{
"rel": "next",
"href": "http://localhost:9900/admin/tasks/com.soa.container.identity/steps/container.identity.select.action"
},
{
"rel": "self",
"href": "http://localhost:9900/admin/tasks/com.soa.container.identity"
},
{
"rel": "steps",
"href": "http://localhost:9900/admin/tasks/com.soa.container.identity/steps"
}
]
}
Parameters
Name
Type
Description
Model
id
path
The ID of the task.
string
step
path
The name of the step.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
stepInfo
stepInfo {
propertySet {
link {
propertyMetadata {
option {
metadata( propertySet )
presentationName( string )
name( string )
description( string )
links( Collection of link )
}
propertySet {
presentationName( string )
children( Collection of propertySet )
name( string )
description( string )
links( Collection of link )
properties( Collection of propertyMetadata )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
propertyMetadata {
maxItems( int )
presentationName( string )
defaultValue( string )
format( string )
pattern( string )
description( string )
type( string )
collectionFormat( string )
exclusiveMaximum( boolean )
minItems( int )
allowEmptyValue( boolean )
uniqueItems( boolean )
name( string )
options( Collection of option )
maximum( string )
exclusiveMinimum( boolean )
minimum( string )
}
option {
presentationName( string )
description( string )
value( string )
}
POST/{id}/steps/{step}/executeExecute Step with a form
Execute a step that accepts form data as part of a task.
Request:
POST /admin/tasks/{task}/steps/{step}/execute HTTP/1.1
Content-Type: application/x-www-form-urlencoded
param1=value1¶m1=value2¶m2=xyz
Response:
The following is an example of a response for a simple step.
{
}
Responses:
- 200 OK If the step executed
- 404 Not Found if the specified task or step are not found
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
id
path
The ID of the task.
string
step
path
The name of the step to execute.
string
body
entity
The property values to process.
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
executionStatus
executionStatus {
link {
stepStatus {
start( dateTime )
progress( int )
end( dateTime )
links( Collection of link )
status( stepStatus )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
stepStatus {
state( state )
detail( string )
}
POST/{id}/steps/{step}/executeExecute Step with an Upload
Execute a step that accepts multipart form data (usually file upload) as part of a task.
Request:
POST /admin/tasks/{task}/steps/{step}/execute HTTP/1.1
Content-Type: multipart/form-data;boundary=xyz
Response:
The following is an example of a response for a simple step.
{
}
Responses:
- 200 OK If the step executed
- 404 Not Found if the specified task or step are not found
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
id
path
The ID of the task.
string
step
path
The name of the step to execute.
string
body
entity
The upload to process.
base64Binary
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
executionStatus
executionStatus {
link {
stepStatus {
start( dateTime )
progress( int )
end( dateTime )
links( Collection of link )
status( stepStatus )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
stepStatus {
state( state )
detail( string )
}
POST/{id}/steps/{step}/executeExecute Step
Execute a step that accepts a JSON array of NameValuePair instances.
Request:
The following is a sample request. Note that there may be multiple values for a single parameter.
POST /admin/tasks/{task}/steps/{step}/execute HTTP/1.1
Content-Type: application/json
[
{"name":"param1","value":"value1"},
{"name":"param1","value":"value2"},
{"name":"param2","value":"xyz"}
]
Response:
The following is an example of a response for a simple step.
{
}
Responses:
- 200 OK If the step executed
- 404 Not Found if the specified task or step are not found
Parameters
Accepts application/json
Name
Type
Description
Model
id
path
The ID of the task.
string
step
path
The name of the step to execute.
string
body
entity
The property values to process.
nameValuePair
nameValuePair {
name( string )
value( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
executionStatus
executionStatus {
link {
stepStatus {
start( dateTime )
progress( int )
end( dateTime )
links( Collection of link )
status( stepStatus )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
stepStatus {
state( state )
detail( string )
}