REST API for Scheduler in OIG

Get the details of a task

get

/iam/governance/selfservice/api/v1/scheduler/tasks/{taskName}

Retrieves the details associated with a task such as a parameter.

Request

Path Parameters

taskName: string

Name of the task

Response

Supported Media Types

application/json

200 Response

Root Schema : Task

Type: object

Show Source

className(optional): string
description(optional): string
name(optional): string

Example: doggie
parameters(optional): array parameters

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"doggie"
        },
        "className":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobParameter"
            }
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

Array of: object JobParameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobParameter"
    }
}

Nested Schema : JobParameter

Type: object

Show Source

dataType(optional): string

Allowed Values: [ "String", "Number", "Boolean", "ITResource" ]
helpText(optional): string
required(optional): boolean
value: string

{
    "required":[
        "value"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "helpText":{
            "type":"string"
        },
        "dataType":{
            "type":"string",
            "enum":[
                "String",
                "Number",
                "Boolean",
                "ITResource"
            ]
        },
        "required":{
            "type":"boolean"
        }
    }
}

400 Response

Invalid input

Examples

The following example shows how to retrieve the details associated with a task such as a parameter by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X GET -u username:password \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/tasks/Application Bulk Create'

Example of Response Body

The following example shows the JSON response for a retrieval request for the details associated with a task:

{
    "name": "Application Bulk Create",
    "className": "oracle.iam.application.task.ApplicationBulkLoadTask",
    "description": "Job to create application in bulk from a directory.",
    "parameters": {
        "Template Directory": {
            "helpText": "Directory path containing XML for seeding Application",
            "required": false,
            "dataType": "String"
        },
        "Archive Directory": {
            "helpText": "Directory path for archive Application XML file after successful processing.",
            "required": false,
            "dataType": "String"
        }
    }
}