Operate projects registered in Systemwalker Operation Manager.
The following operations are available.
Endpoint | HTTP | Operation details |
|---|---|---|
/v1/projects/{projectname} | GET | Gets information for the specified project. |
POST | Perform batch operations on job nets that exist in the specified project. | |
/v1/projects | GET | Gets a list of project information. |
The fields of the objects in the projects resource are as follows.
If you want to specify a project that is unique in the system, specify the project name in the SE version. For EE versions, specify the subsystem number and project name.
Filed Name | Type | Specification |
|---|---|---|
host | String | Host name of the connection destination |
subsystem | Numeric | Subsystem number |
projectname | String | Project name |
normal | Numeric | Number of job nets that ended normally |
abend | Numeric | Number of abnormally terminated job nets |
forced | Numeric | Number of job nets for forced termination |
warning | Numeric | Number of warning job nets |
execute | Numeric | Number of running job nets |
wait | Numeric | Number of job nets waiting to be executed |
pause | Numeric | Number of paused job nets |
disable | Numeric | Number of disabled job nets |
coped | Numeric | Number of confirmed job nets |
pseudo | Numeric | Number of pseudo-normal job nets |
Function Description
Get the target project information by sending a GET method request with the projects resource.
Privilege/Execution Environment Required
You must have at least Browse permission for the specified project.
Requests
GET
/v1/subsystems/{subsystem}/projects/{projectname}
/v1/projects/{projectname} (If you omit the subsystem number)
Under Path Parameters, specify the following parameters.
Parameter | How to specify | Type | Specification |
|---|---|---|---|
subsystem | Path | Numeric | Specifies the subsystem number (from 0 to 9) on which this project resides. If you omit the subsystem number, the value is 0. |
projectname(*) | Path | String | Specify the target project name. |
(*):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 project does not exist.
|
500 | An error occurred on the server while processing the request. |
Returns the object for the target projects resource.
Usage Examples
An example of using the API to get a project with subsystem number 0 and project name "SampleProject" is as follows. Note that the response example shows the objects of the projects 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 HTTP/1.1 Host: Systemwalker Operation Manager server hostname:9900 Authorization: Basic ********************
{
"host": "Systemwalker Operation Manager server hostname",
"subsystem": 0,
"projectname": "SampleProject",
"normal": 0,
"abend": 0,
"forced": 0,
"warning": 0,
"execute": 0,
"wait": 0,
"pause": 0,
"disable": 0,
"coped": 0,
"pseudo": 0
}Function Description
Send a POST method request with the projects resource to perform bulk operations (Pause All, Continue All, Disable All, Enable All) on job nets that exist in the target project.
Privilege/Execution Environment Required
You must have at least permissions to the specified project.
Requests
POST
/v1/subsystems/{subsystem}/projects/{projectname}
/v1/projects/{projectname} (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 | Specifies the subsystem number (from 0 to 9) on which this project resides. If you omit the subsystem number, the value is 0. |
projectname(*) | Path | String | Specify the target project name. |
control(*) | Body | List | Possible values are: pause : Pause All |
(*):Required Parameters
Path: Path parameters
Body: Request bodies
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 project does not exist. |
409 | The specified operation cannot be performed on the target project.
|
500 | An error occurred on the server while processing the request. |
Returns an object for the specified projects 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.
If one of the job nets in the target project cannot be operated, processing is not interrupted and all the job nets that can be operated are processed. In this case, it responds in the form of an abnormal termination response.
Usage Examples
The following is an example of using the API to perform a "Pause All" operation on a project whose subsystem number is 0 and whose project name is "SampleProject".
POST /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject HTTP/1.1
Host: Systemwalker Operation Manager server hostname:9900
Authorization: Basic ********************
Content-Type: application/json
{
"control": "pause"
}Refer to the response example of the "17.3.1.1 Getting Project Information".
Function Description
Gets the list of projects resources.
This applies to projects where the user specified in the credentials has at least Browse rights.
Requests
GET
/v1/projects
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 an object from the projects resource.
Usage Examples
The following is an example of how to use the API to get a list of projects that belong to subsystem number 0.
GET /Systemwalker-omgr/api/v1/projects?subsystem=0 HTTP/1.1 Host: Systemwalker Operation Manager server hostname:9900 Authorization: Basic ********************
Returns an object from the projects resource as an array of objects in the data field. For the object of the projects resource, refer to the response example of the "17.3.1.1 Getting Project Information".