7.1.8 Registration cancellation API
This API cancels registration of a specified jobnet for which execution registration has been performed.
For details about registration cancellation, see 4.5.1 Canceling registration of a jobnet in the manual JP1/Automatic Job Management System 3 Overview.
- Execution privileges
-
The login JP1 user must have one of the following JP1 permissions for the unit for which fixed execution registration is performed:
-
JP1_AJS_Admin privileges
-
JP1_AJS_Manager privileges
-
JP1_AJS_Operator privileges
-
- Request format
-
- Request line
POST /application/component/apiVersion/objects/definitions/unitName/actions/cancelRegistration/invoke httpVersion
- Message body
{ "parameters":{ "manager":"manager-host-name-or-IP-address", "serviceName":"scheduler-service-name", "dateType":"calendar-date-or-execution-date" "begin":"start-date-of-the-period-for-which-registration-is-to-be-canceled" "end":"end-date-of-the-period-for-which-registration-is-to-be-canceled" } }
- API version
-
v1
- Information that uniquely identifies a resource
-
The table below describes the information that uniquely identifies a resource.
If a parameter is not specified or is specified incorrectly, an error with the status code 404 occurs because the resource cannot be uniquely identified.
Information that uniquely identifies a resource
Data type
Description
Required?
unitName
string
Specify the full name of the unit to be requested, by using a character string in the range from 1 to 930 bytes.
Y
- Legend:
-
Y: Required
- Parameter
-
The following table lists and describes the parameters that can be specified for parameters in the request message body.
Table 7‒8: List of parameters for the registration cancellation API Parameter
Data type
Description of the value
Required?
manager
string
Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.
Y
serviceName
string
Specify the scheduler service name by using a character string in the range from 1 to 30 bytes.
Y
dateType#
string
Specify the period for which execution registration is to be canceled, by using a calendar date or execution date, or by using a character string constant specified for the DateType constant. For details about the DateType constant, see 7.4.1(1) DateType.
If you do not want to specify the period for which execution registration is to be canceled, specify null for this parameter, or do not specify this parameter.
--
begin#
string
Specify the start date of the period for which execution registration is to be canceled, in the YYYY-MM-DD format. You can specify the following values:
-
YYYY: specify the year.
You can specify the year in the range from 1994 to 2036 (unit: year).
-
MM: Specify the month.
You can specify the month in the range from 01 to 12 (unit: month).
-
DD: Specify the day.
You can specify the day in the range from 01 to the last day of the specified month (unit: day).
Specify the date by using the local date for the scheduler service of the request-destination JP1/AJS3 - Manager.
If you do not want to specify the period for which execution registration is to be canceled, specify null for this parameter, or do not specify this parameter.
--
end#
string
Specify the end date of the period for which execution registration is to be canceled, in the YYYY-MM-DD format. You can specify the following values:
-
YYYY: specify the year.
You can specify the year in the range from 1994 to 2036 (unit: year).
-
MM: Specify the month.
You can specify the month in the range from 01 to 12 (unit: month).
-
DD: Specify the day.
You can specify the day in the range from 01 to the last day of the specified month (unit: day).
Specify the date by using the local date for the scheduler service of the request-destination JP1/AJS3 - Manager.
Note that you must specify, for this parameter, a value that is equal to or later than the date specified for the begin parameter. If you specify a value that is earlier than the date specified for the begin parameter, an error occurs.
If you do not want to specify the period for which execution registration is to be canceled, specify null for this parameter, or do not specify this parameter.
--
- Legend:
-
Y: Required
--: Optional
-
- #
-
If you omit all the dateType, begin, and end parameters, execution registration of all specified jobnets is canceled.
If you cancel execution registration by specifying the period, specify all the dateType, begin, and end parameters. If you omit any of the parameters, an error occurs.
- Status code
-
The following table lists and describes the status codes returned as a response:
Status code
Message
Description
200
OK
Canceling registration was successful.
400
Bad Request
An argument is invalid.
401
Unauthorized
Authentication is required.
403
Forbidden
The operator does not have execution permission.
404
Not found
The operator does not have access permission for the resource, or the resource does not exist.
409
Conflict
The processing cannot be continued because the request is inconsistent with the current resource status.
412
Precondition failed
The Web Console server is not available.
500
Server-side error
A processing error occurred in the Web Console server.
- Return values
-
None (The size of the response message body is 0 bytes.)
- Example 1
-
The following shows an example of using the API that cancels registration of the specified jobnet registered for execution.
- Example request:
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/cancelRegistration/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "serviceName":"AJSROOT1" } }
- Example response:
HTTP/1.1 200 OK Content-Type: text/plain Cache-Control: no-store, no-cache, max-age=0 Date: Wed, 02 Sep 2015 13:28:39 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server
- Example 2
-
The following shows an example of using the API that cancels execution registration of the jobnet by specifying the period.
- Example request:
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/cancelRegistration/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "serviceName":"AJSROOT1", "dateType":"CALENDAR_DATE", "begin":"2015-09-09", "end":"2015-09-11" } }
- Example response:
HTTP/1.1 200 OK Content-Type: text/plain Cache-Control: no-store, no-cache, max-age=0 Date: Wed, 02 Sep 2015 13:30:04 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server