7.1.8　保留属性変更API

指定したユニットの保留属性を変更します。

保留属性の変更については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.5.6 ジョブネットやジョブの保留属性を一時変更する」を参照してください。

実行権限

ログインしたJP1ユーザーが，保留属性を変更するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/statuses/unitName:execID/actions/changeHold/invoke httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "holdAttr":"保留属性設定または保留解除"
  }
}

APIのバージョン

リソースを一意に識別する情報

リソースを一意に識別する情報を次の表に示します。

なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。

リソースを一意に識別する情報	データ型	値の説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須
execID	string	実行IDを，文字列で指定します。指定する形式は「`@[`mmmm`]{`A〜Z`}`nnnn」です（例：`@10A200`）`。`	必須

リソースを一意に識別する情報

データ型

値の説明

必須・任意

unitName

string

要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。

必須

execID

string

実行IDを，文字列で指定します。

指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。

必須

パラメーター

リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。

表7‒8　保留属性変更APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`holdAttr`	string	保留属性設定か保留解除かを，定数`ChangeHoldAttr`に規定されている文字列定数で指定します。定数`ChangeHoldAttr`の詳細については，「7.4.8(1) ChangeHoldAttr」を参照してください。	必須

ステータスコード

レスポンスで返却するステータスコードを次の表に示します。

ステータスコード	メッセージ	説明
200	OK	保留属性の変更が成功しました。
400	Bad Request	引数が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
409	Conflict	リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

戻り値

なし（レスポンスのメッセージボディのサイズは0バイトです）

使用例1

指定したジョブネットに保留属性を設定するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/changeHold/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "holdAttr":"SET"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

使用例2

指定したジョブネットの保留を解除するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/changeHold/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "holdAttr":"RELEASE"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

ページの先頭へ

7.1.8 保留属性変更API

7.1.8　保留属性変更API