Operates a jobnet registered in Systemwalker Operation Manager.
The following operations are available.
Endpoint | HTTP | Operation details |
|---|---|---|
/v1/projects/{projectname}/jobnets/{jobnetname} | GET | Gets information about the specified job net. |
POST | Operates the specified job net. | |
/v1/jobnets | GET | Gets a list of job net information. |
The fields of the objects in the jobs resource are as below.
If you want to specify a project that is unique in the system, specify the project name and job net name in the SE version. For EE versions, specify the subsystem number, project name and job net name.
Filed Name | Type | Specification |
|---|---|---|
host | String | Host name of the connection destination |
subsystem | Numeric | Subsystem number |
projectname | String | Project name |
jobnetname | String | Job net name |
jobnetcomment | String | Job net comment |
parentname | String | Parent job net name If the job net is a child job net or a linked job net, the parent job net name is returned. If the job net is registered in a group, the group name is returned. If none of the above is true, an empty string is returned. |
layertype | List | Layer type (Note 1) |
linktype | List | Linked job net type (Note 2) |
copystarttype | List | Copy strat type (Note 3) |
execcondition | List | Job net execution conditions (Note 4) |
defaulthost | String | Default host name If more than one item is specified, they are separated by a comma (,). |
execpattern | String | Schedule pattern name If more than one item is specified, they are separated by a half-width space. |
holidaycalendar | String | Calendar name If more than one item is specified, they are separated by a comma (,). |
messagename | String | Message name If more than one item is specified, they are separated by a comma (,). |
status | List | Job net status (Note 5) |
remarks | String | Job net remarks |
starttime | Date and time | Last start date and time |
endtime | Date and time | Last end date and time |
scheduledtime | Date and time | Next scheduled start date and time |
estimatedendtime | Date and time | Next scheduled end date and time |
The values returned for the layertype field are:
Field values | Layer type |
|---|---|
None | None |
Parent | Parent job net |
Child | Child job net |
Grouped | Job net registered in the group |
The values returned for the linktype field are:
Field values | Linked job net type |
|---|---|
None | None |
Linked | Linked job net |
MasterLinked | Master linked job net |
The values returned for the copystarttype field are:
Field values | Copy strat type |
|---|---|
None | None |
CopySource | Copy source job net name |
Copied | Copy destination job net name |
The values returned for the execcondition field are:
Field values | Job net execution conditions |
|---|---|
None | None |
SingleTime | Start time (Single startup) |
MultiTime | Start time (Multiple startup) |
Interval | Execution interval |
ServerStartup | Start at server startup |
MessageEvent | Start only when a message event occurs |
The values returned for the status field are:
Field values | Job net status |
|---|---|
Abend | Abnormally ended |
Warning | Warning |
Forced | Canceled |
CarryOver | Carried over |
StartDelay | Execution delayed |
EndDelay | Completion delayed |
Pause | Paused |
Execute | Running |
Wait | Waiting |
Pseudo | Pseudo-normal |
Normal | Normally completed |
Coped | Confirmed |
Disable | Disabled |
Function Description
Get the target job net information by sending a GET method request with the jobs resource.
Privilege/Execution Environment Required
You must have at least Browse permission for the project in which the specified job net exists.
Requests
GET
/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}
/v1/projects/{projectname}/jobnets/{jobnetname} (If you omit the subsystem number)
Under Path Parameters, specify the following parameters.
Parameter | How to specify | Type | Specification |
|---|---|---|---|
subsystem | Path | Numeric | Specify the subsystem number (from 0 to 9) on which the target jobnet resides. If you omit the subsystem number, the value is 0. |
projectname(*) | Path | String | Specify the name of the project in which the target job net exists. |
jobnetname(*) | Path | String | Specify the name of the target job net. |
(*):Required Parameters
Path: Path parameters
Response
Returns the following HTTP status codes.
Code | Specification |
|---|---|
200 | Processing of the request was successful. |
401 | The credential is specified incorrectly. |
404 | The target job net does not exist.
|
500 | An error occurred on the server while processing the request. |
Returns the object of the target jobnets resource.
Usage Examples
An example of using the API to get a project with subsystem number 0, project name "SampleProject" and job net name "SampleJobnet" is as follows. Note that the response example shows the objects of the jobnets resource that are stored in the data field, and the response header and other fields are omitted.
GET /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet HTTP/1.1 Host: Systemwalker Operation Manager server hostname:9900 Authorization: Basic ********************
{
"host": "Systemwalker Operation Manager server hostname",
"subsystem": 0,
"projectname": "SampleProject",
"jobnetname": "SampleJobnet",
"jobnetcomment": "SampleJobnet_Comment",
"parentname": "",
"layertype": "None",
"linktype": "None",
"copystarttype": "None",
"execcondition": "SingleTime",
"defaulthost": "SampleHost",
"execpattern": "execpattern1",
"holidaycalendar": "holidaycalendar1",
"messagename": "message1",
"status": "Normal",
"remarks": "SampleJobnet_Memo",
"starttime": "2019/12/31 12:00:00",
"endtime": "2019/12/31 12:00:01",
"scheduledtime": "2020/01/01 12:00:00",
"estimatedendtime": "2020/01/01 12:00:01"
}Function Description
Operate (Cancel/Start/Restart/Pause/Continue/Disable/Enable/Confirm/Reinstate/Revoke) the target job net by sending a POST method request specifying the jobnets resource.
Privilege/Execution Environment Required
You must have at least the operation permissions for the project in which the specified job net exists.
Requests
POST
/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}
/v1/projects/{projectname}/jobnets/{jobnetname} (If you omit the subsystem number)
Under Path Parameters and Request Body, specify the following parameters.
Parameter | How to specify | Type | Specification |
|---|---|---|---|
subsystem | Path | Numeric | Specify the subsystem number (from 0 to 9) on which the target job net resides. If you omit the subsystem number, the value is 0. |
projectname(*) | Path | String | Specify the name of the project in which the target job net exists. |
jobnetname(*) | Path | String | Specify the name of the target job net. |
control(*) | Body | List | Specify the operation type for the job net. (Note 1) |
vparam | Body | String | Specify the variable parameters. |
(*):Required Parameters
Path: Path parameters
Body: Request bodies
Possible values for the message body control parameter are:
Specified value | Specification |
|---|---|
start | Start the job net. |
cancel | Forcibly terminates the job net. |
cope | Place the abnormally terminated job net in the confirmed status. |
reinstate | Cancels termination of the job net. |
revoke | Uncarries the job net. |
pause | Places the job net in a stopped state. |
continue | Sets the status of the job net before it is stopped. |
disable | Disables the job net. |
enable | Sets the status of the jobnet before it is disabled. |
rerun | Restart a jobnet that was abnormally terminated, forcibly terminated, or confirmed. |
Response
Returns the following HTTP status codes.
Code | Specification |
|---|---|
202 | Processing of the request was successful. |
400 | The request parameter is invalid.
|
401 | The credential is specified incorrectly. |
403 | You do not have permission to this project. |
404 | The target job net does not exist.
|
409 | You cannot specify an operation for the target job net.
|
500 | An error occurred on the server while processing the request. |
Returns the object for the specified jobnets resource.
Note
Web API operations on job nets that exist in a project are not synchronized with Systemwalker Operation Manager server operations. Therefore, Web API responses do not guarantee that the server will complete its processing. Objects returned in the response body may not reflect the operation.
When you start the copy source job net, the system returns the information about the copy source job net. Get the copy destination job net information from the job net information list.
Usage Examples
An example of using the API to get a project with subsystem number 0, project name "SampleProject" and job net name "SampleJobnet" is as follows.
POST /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet HTTP/1.1
Host: Systemwalker Operation Manager server hostname:9900
Authorization: Basic ********************
Content-Type: application/json
{
"control": "start",
"vparam": "SampleParam"
}Refer to the response example of the "17.3.2.1 Getting Job net Information".
Function Description
Get a list of jobnets resources.
The target job net is a jobnet that exists in a project in which the user specified in the credentials has reference rights or more.
Requests
GET
/v1/jobnets
Common query parameters are available.
For more information, refer to the "17.2.3.2 Request Format".
Response
Returns the following HTTP status codes.
Code | Specification |
|---|---|
200 | Processing of the request was successful. |
400 | The request parameter is invalid.
|
401 | The credential is specified incorrectly. |
500 | An error occurred on the server while processing the request. |
Returns the object for the jobnets resource.
Usage Examples
The following example shows how to use the API to get the list of job nets that exist in subsystem 0.
GET /Systemwalker-omgr/api/v1/jobnets?subsystem=0 HTTP/1.1 Host: Systemwalker Operation Manager server hostname:9900 Authorization: Basic ********************
Returns an object from the jobnets resource as an array of objects in the data field. For the objects in the jobnets resource, refer to the response example of the "17.3.2.1 Getting Job net Information".