Overview
本APIでは、Global Management Oneサービスにおける各種情報の取得を行うことができます。
ご利用いただくためには事前のお申し込みが必要になります。
弊社のお客様営業担当にご連絡ください。お客様担当の弊社営業担当がいない場合は、開発者ポータル内「サポート」メニュー中の「お問い合わせ」にございますお問い合わせフォームよりお申し込みください。
Globale Management Oneのサービス概要については、 こちらでご確認いただけます。
Resource URL
グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。1
1.Base Path(Global Load Balance)
https://api.ntt.com/v1/gmone/
2.Base Path(Region)
https://{region}.api.ntt.com/v1/gmone/
- region is jp|us|uk
- e.g. https://us.api.ntt.com/v1/gmone
- 指定できるregionは、将来拡充予定
Key |
Value |
レスポンス フォーマット |
JSON or csv |
認証(OAuth) |
Yes |
帯域制御#1 |
Yes |
インシデント管理チケットAPI
/v1/gmone/im/
Global Management One システムより、インシデント管理チケットの情報を取得します。
チケット情報取得(チケットID指定)
GET /v1/gmone/im/tickets/${ticketID}
インシデント管理チケットを、チケットのIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
ticketID |
参照したいチケットのIDを指定 |
number |
true |
Examplet Request
GET /v1/gmone/im/tickets/123
Response Parameters
Name |
Description |
Type |
ticketId |
チケットID |
number |
subject |
件名 |
string |
requestors |
チケット申請者メールアドレスリスト |
string array |
client |
クライアントコード |
string |
owner |
チケット対応者ユーザ名 |
string |
queue |
チケットキュー |
string |
priority |
重要度(P1~P4, null) |
string |
status |
チケットステータス |
string (詳細は別途) |
createdDate |
作成日時 |
number (epoc milliseconds) |
updatedDate |
最終更新日時 |
number (epoc milliseconds) |
resolvedDate |
対応終了日時 |
number (epoc milliseconds) |
correlatedTicketIds |
関連先チケットIDリスト |
number array |
masterTicketId |
関連元チケットID |
number |
ccs |
更新通知CCメールアドレスリスト |
string |
adminCcs |
更新通知AdminCC(BCC)メールアドレスリスト |
string |
lastUpdatedBy |
最終更新者ユーザ名 |
string |
serviceCheck |
インシデント対象サービスチェック |
string |
cis |
インシデント対象構成アイテムリスト |
string array |
"status" Parameter List
Value |
Description |
new |
新規、対応者なし |
active |
対応中 |
pending close |
暫定クローズ |
pending vendor |
ベンダ応答待ち |
pending event |
先行イベントの完了待ち |
pending client |
お客様応答待ち |
hand-off |
引継ぎ中 |
resolved |
対応終了 |
Example Response
{
"ticketId": 123,
"subject": "example ticket",
"requestors": [
"example@example.com"
],
"client": "example",
"owner": "example",
"queue": "example-general",
"priority": "P3",
"status": "active",
"createdDate": 1472124530000,
"updatedDate": 1472208340000,
"resolvedDate": 0,
"correlatedTicketIds": null,
"masterTicketId": null,
"ccs": [
"qwerty@example.com"
],
"adminCcs": [
"zxcvbn@example.com"
],
"lastUpdatedBy": "example",
"serviceCheck": null,
"cis": [
"exampleci.example"
]
}
チケット検索(検索条件指定)
GET /v1/gmone/im/tickets?key=value
インシデント管理チケットを、検索条件を指定する形で絞り込み、検索します。
Request Parameters
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
ticketId |
チケットID |
number |
false |
Empty |
queue |
チケットキュー |
string |
false |
Empty |
client |
クライアントコード |
string |
false |
APIユーザーアカウントのクライアント |
requestor |
チケット申請者 |
string |
false |
Empty |
CI |
チケット関連CI |
string |
false |
Empty |
serviceCheck |
チケットID |
string |
false |
Empty |
priority |
チケット重要度 |
string (fixed: P1, P2, P3, P4) |
false |
Empty |
status |
チケットステータス |
string (下記参照) |
false |
Empty |
limit |
返り値数上限 |
number |
false |
Empty |
idDirection |
チケットIDソート順(昇順[asc]、降順[desc]) |
string (fixed: asc / desc) |
false |
Empty |
createdAfter |
作成日時(以降) |
number (epoc millisecond) |
false |
Empty |
createdBefore |
作成日時(以前) |
number (epoc millisecond) |
false |
Empty |
updatedAfter |
最終更新日時(以降) |
number (epoc millisecond) |
false |
Empty |
updatedBefore |
最終更新日時(以前) |
number (epoc millisecond) |
false |
Empty |
resolvedAfter |
対応クローズ日時(以降) |
number (epoc millisecond) |
false |
Empty |
resolvedBefore |
対応クローズ日時(以前) |
number (epoc millisecond) |
false |
Empty |
"status" Parameter List
Value |
Description |
new |
新規、対応者なし |
active |
対応中 |
pending close |
暫定クローズ |
pending vendor |
ベンダ応答待ち |
pending event |
先行イベントの完了待ち |
pending client |
お客様応答待ち |
hand-off |
引継ぎ中 |
resolved |
対応終了 |
Examplet Request
GET /v1/gmone/im/tickets?status=active&queue=example-general&priority=P3&idDirection=desc
Response Parameters
Name |
Description |
Type |
ticketId |
チケットID |
number |
subject |
件名 |
string |
requestors |
チケット申請者メールアドレスリスト |
string array |
client |
クライアントコード |
string |
owner |
チケット対応者ユーザ名 |
string |
queue |
チケットキュー |
string |
priority |
重要度(P1~P4, null) |
string |
status |
チケットステータス |
string (下記参照) |
createdDate |
作成日時 |
number (epoc milliseconds) |
updatedDate |
最終更新日時 |
number (epoc milliseconds) |
resolvedDate |
対応終了日時 |
number (epoc milliseconds) |
correlatedTicketIds |
関連先チケットIDリスト |
number array |
masterTicketId |
関連元チケットID |
number |
"status" Parameter List
Value |
Description |
new |
新規、対応者なし |
active |
対応中 |
pending close |
暫定クローズ |
pending vendor |
ベンダ応答待ち |
pending event |
先行イベントの完了待ち |
pending client |
お客様応答待ち |
hand-off |
引継ぎ中 |
resolved |
対応終了 |
Example Response
[
{
"ticketId": 312,
"subject": "example ticket #3",
"requestors": [
"example@example.com"
],
"client": "example",
"owner": "example",
"queue": "example-general",
"priority": "P3",
"status": "active",
"createdDate": 1472125290000,
"updatedDate": 1472125291000,
"resolvedDate": 0,
"correlatedTicketIds": null,
"masterTicketId": null
},
{
"ticketId": 231,
"subject": "example ticket #2",
"requestors": [
"asdfgh@example.com"
],
"client": "example",
"owner": "example2",
"queue": "example-general",
"priority": "P3",
"status": "active",
"createdDate": 1471848940000,
"updatedDate": 1471947900000,
"resolvedDate": 0,
"correlatedTicketIds": null,
"masterTicketId": null
}
]
チケットログ取得(チケットID指定)
GET /v1/gmone/im/tickets/${ticketID}/log
インシデント管理チケットの対応ログを、チケットのIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
ticketID |
参照したいチケットのIDを指定 |
number |
true |
Examplet Request
GET /v1/gmone/im/tickets/123/log
Response Parameters
Name |
|
Description |
Type |
actor |
|
ログ投稿者 |
number |
actionDate |
|
ログ追記日時 |
string |
actionType |
|
ログのタイプ(下記参照) |
string array |
post |
|
コメント内容 |
string |
oldValue |
|
更新前の値 |
string |
newValue |
|
更新した値 |
string |
attachments |
attachmentName |
添付ファイル名 |
string |
|
attachmentID |
添付ファイルID |
number |
"actionType" Parameter List
Value |
Description |
Create |
チケット作成 |
Add Log |
ログ追記 |
Add Requestor |
チケット申請者追加 |
Delete Requestor |
チケット申請者削除 |
Add CC |
チケット通知CC追加 |
Delete CC |
チケット通知CC削除 |
Add Admin CC |
チケット通知Admin CC追加 |
Delete Admin CC |
チケット通知Admin CC削除 |
Change Owner |
対応者変更 |
Change Queue |
チケットキュー変更 |
Change Status |
ステータス変更 |
Change Prority |
重要度変更 |
Subject Change |
件名変更 |
Add CI |
関連CI追加 |
Remove CI |
関連CI削除 |
Example Response
[
{
"actor": "example",
"actionDate": 1472203317000,
"actionType": "Add Log",
"post": "example update",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "excustomer",
"actionDate": 1472208203000,
"actionType": "Add Log",
"post": "example customer update",
"oldValue": null,
"newValue": null,
"attachments": [
{
"attachmentName": "FileToTest.txt",
"attachmentID": 730
}
]
},
{
"actor": "example",
"actionDate": 1472208340000,
"actionType": "Change Status",
"post": null,
"oldValue": "active",
"newValue": "resolved",
"attachments": null
}
]
チケット添付ファイル一覧取得(チケットID指定)
GET /v1/gmone/im/tickets/${ticketID}/attachments
インシデント管理チケットの添付ファイル一覧を、チケットのIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
ticketID |
参照したいチケットのIDを指定 |
number |
true |
Examplet Request
GET /v1/gmone/im/tickets/123/attachments
Response Parameters
Name |
Description |
Type |
attachmentName |
添付ファイル名 |
string |
attachmentID |
添付ファイルID |
number |
Example Response
[
{
"attachmentName": "ExampleFile.txt",
"attachmentID": 730
}
]
チケット添付ファイル取得(チケットID、添付ファイルID指定)
GET /v1/gmone/im/tickets/${ticketID}/attachments/${attachmentID}
インシデント管理チケットの添付を、添付ファイルのIDとその添付ファイルの存在するチケットのIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
ticketID |
参照したいチケットのIDを指定 |
number |
true |
attachmentID |
参照したい添付ファイルのIDを指定 |
number |
true |
Example Request
GET /v1/gmone/im/tickets/123/attachments/730
Response Parameters
ありません。返り値は添付ファイルそのもので、Content-Typeは"application/octet-stream"です。
Example Response
これはテストファイルです。
チケット情報更新(チケットID指定)
PUT /v1/gmone/im/tickets/${ticketID}
インシデント管理チケットの情報を変更・更新します。
Request Parameters
Body
Name |
Description |
Type |
Mandatory |
Default value |
subject |
チケットの件名 |
string |
false |
現在の件名 |
requestors |
チケット申請者 |
string array |
false |
現在の申請者 |
ccs |
チケット通知CCメールアドレス |
string array |
false |
現在のCCメールアドレス |
adminCcs |
チケット通知Admin CC(BCC)メールアドレス |
string array |
false |
現在のAdmin CC(BCC)メールアドレス |
CIs |
チケット関連CI |
string |
false |
現在のCI |
Example Request
PUT /v1/gmone/im/tickets/123
request body:
{
"subject": "test ticket subject",
"requestors": ["example"],
"ccs": ["zxcvbn@example.com"],
"adminCcs": ["asdfgh@example.dum"],
"CIs": ["exampleci.example"],
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
ticketId |
操作したチケットID |
number |
Example Response
{
"result": "success",
"ticketId": 123
}
チケットログ追記
POST /v1/gmone/im/tickets/${ticketId}/log
インシデント管理チケットに、ログを追記します。
Request Parameters
Body
Name |
Description |
Type |
Mandatory |
Default value |
post |
チケットログ本文 |
string |
true |
N/A |
poster |
チケットログ投稿者 |
string |
false |
APIユーザーアカウント |
onetimeCc |
通知CCメールアドレス |
string |
false |
Empty |
onetimeBcc |
通知BCCメールアドレス |
string |
false |
Empty |
attachments |
添付ファイル情報 |
Object Array |
false |
Empty |
"attachements" Object List
Name |
Description |
Type |
Mandatory |
Default value |
name |
添付ファイル名 |
string |
true |
N/A |
content |
添付ファイルの内容 |
string (Base64 Encoded Binary) |
true |
N/A |
Example Request
POST /v1/gmone/im/tickets/1010011/log
Request Body
{
"post": "example",
"poster": "example",
"onetimeCc": ["example@example.com"],
"onetimeBcc": ["example@example.com"],
"attachments": [{
"name": "example.txt",
"content": "44GT44KM44Gv44OG44K544OI44OV44Kh44Kk44Or44Gn44GZ44CC"
}]
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
ticketId |
操作したチケットID |
number |
Example Response
{
"result": "success",
"ticketId": 1010011
}
チケット作成
POST /v1/gmone/im/tickets
インシデント管理チケットを、必要事項を記入し、作成します。
Request Parameters
Body
Name |
Description |
Type |
Mandatory |
Default value |
post |
チケット本文 |
string |
true |
N/A |
subject |
チケット件名 |
string |
true |
N/A |
requestors |
チケット申請者(ユーザー名もしくはメールアドレス) |
string array |
false |
APIユーザーアカウント |
client |
クライアントコード |
string |
false |
APIユーザーアカウントのクライアント |
queue |
チケットキュー |
string |
false |
general キュー |
CIs |
チケット関連CI |
string array |
false |
Empty |
ccs |
チケット通知CCメールアドレス |
string array |
false |
Empty |
adminCcs |
チケット通知Admin CC(BCC)メールアドレス |
string array |
false |
Empty |
attachments |
添付ファイル |
Object Array |
false |
N/A |
"attachements" Object List
Name |
Description |
Type |
Mandatory |
Default value |
name |
添付ファイル名 |
string |
true |
N/A |
content |
添付ファイルの内容 |
string (Base64 Encoded Binary) |
true |
N/A |
Example Request
POST /v1/gmone/im/tickets
Request Body
{
"post": "example ticket #2",
"subject": "example ticket #2",
"requestors": ["example"],
"client": "example",
"queue": "example",
"CIs": ["example"],
"ccs": ["example@example.com"],
"adminCcs": ["examplei@example.com"],
"attachments": [{
"name": "example.txt",
"content": "44GT44KM44Gv44OG44K544OI44OV44Kh44Kk44Or44Gn44GZ44CC"
}]
}
Response Parameters
Name |
Description |
Type |
ticketId |
チケットID |
number |
Example Response
{
"ticketId": 1010011
}
変更要求API
/v1/gmone/cm/
Global Management One システムより、変更要求に関する情報を取得、操作します。
変更要求API共通
本APIでは、お客様システム等との連携強化のため、APIの実行アカウントとは異なるGMOneポータルのアカウント(実行ユーザー)を指定して実際の処理を行うことができる機能を実装しています。
当機能を利用する際には、GMOneサービス主管にお問い合わせください。
なお、それぞれのAPIごとに、以下のパラメータを利用します。
API Name |
Parameter name |
Section |
変更要求ワークフロー検索 |
requestor |
URL Query |
変更要求ワークフロー取得 |
requestor |
URL Query |
変更要求チケット検索 |
requestor |
URL Query |
変更要求チケット取得 |
requestor |
URL Query |
変更要求チケット添付ファイル一覧取得 |
requestor |
URL Query |
変更要求チケット添付ファイル取得 |
requestor |
URL Query |
変更要求ログ取得 |
requestor |
URL Query |
コミュニケーションログ添付ファイル一覧取得 |
requestor |
URL Query |
コミュニケーションログ添付ファイル取得 |
requestor |
URL Query |
変更要求チケット作成 |
initiator |
Body |
変更要求チケット添付ファイル追加 |
requestor |
URL Query |
変更要求チケット更新 |
requestor |
URL Query |
変更要求チケット処理 |
requestor |
URL Query |
コミュニケーションログ追記 |
poster |
Body |
変更要求ワークフロー検索(検索条件指定)
GET /v1/gmone/cm/workflows?key=value
変更要求チケットの処理ワークフローを、検索条件を指定する形で絞り込み、検索します。
Request Parameters
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
workflowID |
ワークフローID |
number |
false |
Empty |
name |
ワークフロー名 |
string |
false |
Empty |
client |
クライアントコード |
string |
false |
APIユーザーアカウントのクライアント |
createdBefore |
作成日時(以前) |
number (epoc millisecond) |
false |
Empty |
createdAfter |
作成日時(以降) |
number (epoc millisecond) |
false |
Empty |
lastUpdatedBefore |
最終更新日時(以前) |
number (epoc millisecond) |
false |
Empty |
lastUpdatedAfter |
最終更新日時(以降) |
number (epoc millisecond) |
false |
Empty |
includeInactive |
現在使用していないワークフローも結果に含むか |
boolean |
false |
false |
limit |
返り値数上限 |
number |
false |
Empty |
idDirection |
ワークフローIDソート順(昇順[asc]、降順[desc]) |
string (fixed: asc / desc) |
false |
Empty |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/workflows?lastUpdatedAfter=1478307755000&idDirection=desc&limit=5
Response Parameters
Name |
Description |
Type |
workflowID |
ワークフローID |
number |
name |
ワークフロー名 |
string |
client |
クライアントコード |
string |
created |
作成日時 |
number (epoc millisecond) |
lastUpdated |
最終更新日時 |
number (epoc millisecond) |
Example Response
[
{
"workflowID": 63,
"name": "Sample_20161129",
"client": "Sample",
"created": 1480393001000,
"lastUpdated": 1480393001000
},
{
"workflowID": 62,
"name": "Workflow 62",
"client": "Sample",
"created": 1479967552000,
"lastUpdated": 1479967552000
},
{
"workflowID": 45,
"name": "sample-67",
"client": "Sample",
"created": 1476786646000,
"lastUpdated": 1479955434000
},
{
"workflowID": 13,
"name": "NewWorkFLow",
"client": "Sample",
"created": 1467809124000,
"lastUpdated": 1480313583000
},
{
"workflowID": 7,
"name": "fork WF",
"client": "Sample",
"created": 1467294077000,
"lastUpdated": 1479989756000
}
]
変更要求ワークフロー情報取得(ワークフローID指定)
GET /v1/gmone/cm/workflows/${workflowID}
変更要求チケットの処理ワークフローを、IDを指定して取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
workflowID |
ワークフローIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/workflows/17
Response Parameters
Name |
Description |
Type |
workflowID |
ワークフローID |
number |
name |
ワークフロー名 |
string |
notes |
備考・説明など |
string |
client |
所属クライアントコード |
string |
inactive |
現在不使用か |
boolean |
summary |
概要 |
Object (visibility) |
cis |
構成アイテムリスト |
Object (visibility) |
category |
分類 |
Object (visibility) |
priority |
重要度 |
Object (visibility) |
reason |
理由 |
Object (visibility) |
risks |
リスク |
Object (visibility) |
cost |
費用 |
Object (visibility) |
consequences |
想定される結果 |
Object (visibility) |
benefits |
利点 |
Object (visibility) |
serviceAffected |
影響を受けるサービス |
Object (visibility) |
backoutStrategy |
取りやめ時計画 |
Object (visibility) |
rollbackProcedure |
切り戻し手順 |
Object (visibility) |
implementationSteps |
実装手順 |
Object (visibility) |
plannedStartEndDates |
実装開始/終了予定日時 |
Object (visibility) |
attributeDefinitions |
カスタム属性 |
Object array (attributeDefinition) |
返り値がvisibility
のものに関しては、displayed
、required
双方がfalse
のパラメータについては返却されません。
"visibility" entity list
Name |
Description |
Type |
displayed |
表示されるか |
boolean |
required |
必須項目か |
boolean |
"attributeDefinition" entity list
Name |
|
Description |
Type |
workflowAttributeDefinitionID |
|
ワークフローカスタム属性定義ID |
number |
required |
|
必須項目か |
boolean |
hidden |
|
非表示状態か |
boolean |
datumType |
|
データ型 |
string (datumType) |
inputType |
|
カスタム属性の入力形態 |
string (inputType) |
validationDescription |
|
許容可能な入力値の説明 |
string |
attribute |
attributeDefinitionID |
カスタム属性定義ID |
number |
|
name |
カスタム属性名 |
string |
|
description |
カスタム属性表示名 |
string |
rfcSection |
|
ワークフロー上での入力時属性種別 |
string (rfcSection) |
selectList |
name |
セレクトリスト名 |
string |
|
options |
選択肢 |
string array |
|
datumType |
データ型 |
string (datumType) |
Name |
Description |
Oneline |
一行入力欄 |
Multiline |
複数行入力欄 |
List |
選択肢 |
Boolean |
真偽値 |
"datumType" parameter list
Name |
Description |
String |
文字列型 |
Long |
整数型 |
Double |
浮動小数点型 |
Boolean |
真偽値型 |
Date |
日付型 (mm/dd/yyyy) |
Datetime |
日付時刻型 (mm/dd/yyyy hh:mm) |
Text |
文字型 |
Url |
URL型 |
なお、上記パラメータはすべてString
型として入力する必要があります。
例:
{
"name": "sampleAttribute",
"value": "12345" /Long型のattributeですが、数字を文字列としてセットする必要があります/
}
"rfcSection" parameter list
Name |
Description |
Assesment |
ステータスがDRAFT/PENDINGの時に入力可能 |
Authorization |
ステータスがPENDINGの時に入力可能 |
Implement |
ステータスがAPPROVED/IMPLEMENTEDの時に入力可能 |
Closure |
ステータスがAPPROVED/IMPLEMENTEDの時に入力可能 |
Example Response
{
"workflowID": 17,
"name": "Example Workflow",
"client": "Exmaple",
"inactive": false,
"live": true,
"summary": {
"displayed": true,
"required": true
},
"cis": {
"displayed": true,
"required": false
},
"category": {
"displayed": true,
"required": false
},
"priority": {
"displayed": true,
"required": true
},
"plannedStartEndDates": {
"displayed": true,
"required": true
},
"attributeDefinitions": [
{
"workflowAttributeDefinitionID": 3,
"required": false,
"hidden": false,
"validationDescription": "",
"datumType": "Boolean",
"inputType": "Boolean",
"attribute": {
"attributeDefinitionID": 1,
"name": "generic_boolean",
"description": "Passed"
},
"rfcSection": "Assessment"
},
{
"workflowAttributeDefinitionID": 2,
"required": false,
"hidden": false,
"validationDescription": "",
"datumType": "String",
"inpuType": "List",
"attribute": {
"attributeDefinitionID": 3,
"name": "generic_selectlist",
"description": "A list of US states"
},
"rfcSection": "Assessment",
"selectList": {
"name": "generic_selectlist",
"options": [
"(select)",
"A",
"B",
"C",
"D"
],
"datumType": "String",
"autoSort": true
}
}
]
}
変更要求チケット検索(検索条件指定)
GET /v1/gmone/cm/rfcs?key=value
変更要求チケットを、検索条件を指定する形で絞り込み、検索します。
Request Parameters
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
rfcID |
変更要求チケットID |
number |
false |
Empty |
name |
変更要求名 |
string |
false |
Empty |
client |
クライアントコード |
string |
false |
実行ユーザーのクライアント |
ci |
関連CI |
string |
false |
Empty |
status |
ステータス |
string |
false |
Empty |
owner |
変更要求チケット所有者 |
string |
false |
Empty |
initiator |
変更要求チケット作成者 |
string |
false |
Empty |
workflowID |
ワークフローID |
number |
false |
Empty |
idDirection |
変更要求チケットIDソート順(昇順[asc]、降順[desc]) |
string (fixed: asc / desc) |
false |
Empty |
implStartBefore |
実装開始日時(以前) |
number (epoc millisecond) |
false |
Empty |
implStartAfter |
実装開始日時(以降) |
number (epoc millisecond) |
false |
Empty |
myItem |
実行ユーザーの対応待ち変更要求チケットのみ検索 |
boolean |
false |
false |
limit |
返り値数上限 |
number |
false |
Empty |
requestor |
実行ユーザー |
string |
false |
Empty |
"status" Parameter List
Value |
Description |
DRAFT |
送信前 |
PENDING |
承認待ち |
APPROVED |
承認済み |
IMPLEMENTED |
実装済み |
CLOSED |
クローズ済み |
FAILED |
要求不達成 |
Example Request
GET /v1/gmone/cm/v1/rfcs?ci=sample&myItem=true
Response Parameters
Name |
Description |
Type |
rfcID |
変更要求チケットID |
number |
name |
変更要求チケット名 |
string |
client |
クライアントコード |
string |
status |
ステータス |
string (下記参照) |
workflow |
ワークフロー |
Object (workflow) |
created |
作成日時 |
number (epoc millisecond) |
updated |
最終更新日時 |
number (epoc millisecond) |
"status" Parameter List
Value |
Description |
DRAFT |
送信前 |
PENDING |
承認待ち |
APPROVED |
承認済み |
IMPLEMENTED |
実装済み |
CLOSED |
クローズ済み |
FAILED |
要求不達成 |
"workflow" structure
Name |
Description |
Type |
workflowID |
ワークフローID |
number |
name |
ワークフロー名 |
string |
Example Response
[
{
"rfcID": 1357,
"name": "Example RFC 2",
"client": "example",
"workflow": {
"workflowID": 12,
"name": "Example Workflow #2"
},
"created": 1480400330000,
"updated": 1480400330000
}
]
変更要求チケット情報取得(変更要求チケットID指定)
GET /v1/gmone/cm/rfcs/${rfcID}
変更要求チケットを、IDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したい変更要求チケットIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/rfcs/1234
Response Parameters
Top level
Name |
Description |
Type |
rfcID |
変更要求チケットID |
number |
name |
変更要求チケット名 |
string |
workflow |
処理ワークフロー |
Object (workflow) |
client |
クライアントコード |
string |
initiator |
変更要求チケット起票者 |
string |
owner |
変更要求チケット所有者 |
string |
ccs |
更新通知送付先CCリスト |
string(comma separated value list) |
status |
ステータス |
string (status) |
currentState |
現在のワークフローの状態 |
string array |
awaitingActionBy |
処理待ち対象ユーザー名・ユーザーグループ |
string array |
created |
作成日時 |
number(epoc milliseconds) |
updated |
更新日時 |
number(epoc milliseconds) |
plannedStartDate |
作業開始日時(予定) |
number(epoc milliseconds) |
plannedEndDate |
作業終了日時(予定) |
number(epoc milliseconds) |
actualStartDate |
作業開始日時(実績) |
number(epoc milliseconds) |
implementationDate |
作業終了日時(実績) |
number(epoc milliseconds) |
vendorImplementationTime |
実作業時間 |
number |
summary |
概要 |
string |
priority |
重要度 |
string (priority) |
category |
分類 |
string (category) |
reason |
要求理由 |
string |
risks |
作業時リスク |
string |
cost |
費用 |
string |
benefits |
利点 |
string |
consequences |
想定される結果 |
string |
implementationSteps |
実装手順 |
string |
serviceAffected |
影響を受けるサービス |
string |
rollbackProcedure |
切り戻し手順 |
string |
backoutStrategy |
取りやめ時計画 |
string |
implementationEffort |
実装時稼働 |
string |
userTestsComplete |
ユーザーテスト完了日時 |
number(epoc milliseconds) |
acceptanceTestsComplete |
受け入れテスト完了日時 |
number(epoc milliseconds) |
operationTestsComplete |
運用準備テスト完了日時 |
number(epoc milliseconds) |
objectiveAchieved |
実装時結果の詳細 |
string |
findings |
実装時特記事項 |
string |
approvalNotes |
承認時特記事項 |
string |
approvalDate |
変更要求承認日時 |
number(epoc milliseconds) |
rejectionNotes |
差戻時特記事項 |
string |
rejectionDate |
変更要求差戻日時 |
number(epoc milliseconds) |
closureDate |
クローズ時日時 |
number(epoc milliseconds) |
closureCode |
クローズ時分類 |
string (closureCode) |
attributes |
カスタム属性リスト |
object array (attribute) |
cis |
構成アイテムリスト |
object array (ci) |
なお上記はワークフローの種類ないしワークフローの状態によって、返り値として提供されないものもあります。
どの値が提供されるかに関しては、ワークフロー情報取得APIから確認することができます。
"workflow" structure
Name |
Description |
Type |
workflowID |
ワークフローID |
number |
name |
ワークフロー名 |
string |
"attribute" structure
Name |
Description |
Type |
name |
属性名 |
string |
value |
属性値 |
string |
"ci" structure
Name |
Description |
Type |
ciID |
構成アイテムID |
number |
ciName |
構成アイテム名 |
string |
clientID |
所属クライアントID |
number |
typeID |
構成アイテムタイプID |
number |
typeName |
構成アイテムタイプ名 |
string |
"status" Parameter List
Value |
Description |
DRAFT |
送信前 |
PENDING |
承認待ち |
APPROVED |
承認済み |
IMPLEMENTED |
実装済み |
CLOSED |
クローズ済み |
FAILED |
要求不達成 |
"priority" Parameter List
Value |
Description |
LOW |
低 |
NORMAL |
中 |
HIGH |
高 |
URGENT |
緊急 |
"category" Parameter List
Value |
Description |
MARGINAL |
重要でない |
SUBSTANTIAL |
通常 |
CRITICAL |
最重要 |
"closureCode" Parameter List
Value |
Description |
SUCCESSFUL |
実装成功 |
SUCCESSFUL_WITH_ISSUES |
実装成功だが残余課題あり |
ROLLED_BACK |
切り戻し |
CANCELLED |
実装キャンセル |
CLOSED_IN_DRAFT |
承認要求されずにクローズした |
PARTIALLY_IMPLEMENTED |
部分的に実装 |
PARTIALLY_ROLLED_BACK |
部分的に切り戻し |
FAILED |
実装失敗 |
Example Response
{
"rfcID": 1234,
"client": "example",
"initiator": "somecustomer",
"owner": "testuser",
"name": "Sample RFC",
"reason": "",
"implementationSteps": "Sample",
"rollbackProcedure": "Sample",
"ccs": "",
"currentState": [
"Approve"
],
"awaitingActionBy": [
"Test User (testuser) (GMOne)",
"Test User Group",
],
"created": 1480400330000,
"updated": 1480400330000,
"plannedStartDate": 1480423200000,
"plannedEndDate": 1480509600000,
"status": "PENDING",
"priority": "NORMAL",
"category": "SUBSTANTIAL",
"workflow": {
"workflowID": 26,
"name": "Workflow Sample"
},
"attributes": [
{
"name": "Attribute 1",
"value": "aaa"
},
{
"name": "Attribute 2",
"value": "bbb"
}
],
"cis": [
{
"ciID": 9,
"ciName": "example_ci.example",
"clientID": 19,
"client": "example",
"typeID": 21,
"typeName": "Virtual Device"
}
]
}
変更要求チケット添付ファイル一覧取得(変更要求チケットID指定)
GET /v1/gmone/cm/rfcs/${rfcID}/files
変更要求チケットへの添付ファイル一覧を、変更要求のIDを指定する形で取得します。
このAPIは、変更要求の作成、申請時に変更要求に必要に応じて添付されたファイルの一覧を取得するためのものです。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したい変更要求チケットIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/rfcs/1234/files
Response Parameters
Name |
Description |
Type |
fileName |
添付ファイル名 |
number |
fileId |
添付ファイルID |
string |
Example Response
[
{
"fileName": "testData.txt",
"fileId": 224
}
]
変更要求チケット添付ファイル取得(変更要求チケットID、添付ファイルID指定)
GET /v1/gmone/cm/rfcs/${rfcID}/files/${fileID}
変更要求チケットの添付ファイルを、添付ファイルのIDとその添付ファイルの存在する変更要求のIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したいチケットのIDを指定 |
number |
true |
fileID |
参照したい添付ファイルのIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/rfcs/1234/attachments/224
Response Parameters
ありません。返り値は添付ファイルそのもので、Content-Typeは"application/octet-stream"です。
Example Response
これはテストファイルです。
変更要求チケットログ取得(変更要求チケットID)
GET /v1/gmone/im/rfcs/${rfcID}/log
変更要求チケットの対応ログを、チケットのIDを指定する形で取得します。
GMOne システムにおいて、変更要求チケットのログには以下の二種類が存在しています。
1. 変更要求チケットログ
1. コミュニケーションログ
それぞれのログの役割は以下の通りになります。
-
変更要求チケットログ
-
変更要求チケット内での
- 変更要求内容の更新
- ワークフロー処理の履歴
- 担当者変更
などを記録しているログ
-
コミュニケーションログ
- 該当の変更要求について、その起案や処理の状況についてお客様に通知し
また関連する事項についてお客様とやり取りするためのチケットのログ
上記二つのログのうち、どちらを出力の対象とするかについては、URL QueryパラメータlogType
で指定できます。
なおlogType
を指定しなかった場合は、両方のログが出力の対象になります。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したい変更要求チケットIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
logType |
出力するログのタイプを指定 |
string (logType) |
false |
Empty |
requestor |
実行ユーザー |
string |
false |
Empty |
Definition of Parameter "logType"
Name |
Description |
rfc |
変更要求内容の更新を出力 |
communication |
コミュニケーションログを出力 |
Example Request
GET /v1/gmone/cm/rfcs/1234/log
Response Parameters
Name |
Description |
Type |
communicationLog |
コミュニケーションログ |
object array (communicationLog) |
rfcLog |
変更要求チケットログ |
object array (rfcLog) |
communicationLog entity
Name |
|
Description |
Type |
actor |
|
ログ投稿者 |
string |
actionDate |
|
ログ追記日時 |
number (epoc milliseconds) |
actionType |
|
ログのタイプ |
string (actionType) |
post |
|
コメント内容 |
string |
oldValue |
|
更新前の値 |
string |
newValue |
|
更新した値 |
string |
attachments |
attachmentName |
添付ファイル名 |
string |
|
attachmentID |
添付ファイルID |
number |
rfcLog entity
Name |
|
Description |
Type |
created |
|
ログ記録日時 |
number (epoc milliseconds) |
user |
|
更新者 |
string |
action |
|
ログのタイプ(下記参照) |
string (action) |
diff |
key |
更新対象の内容 |
string |
|
oldValue |
更新前の値 |
string |
|
newValue |
更新した値 |
string |
"actionType" Parameter List
Value |
Description |
Create |
チケット作成 |
Add Log |
ログ追記 |
Add Requestor |
チケット申請者追加 |
Delete Requestor |
チケット申請者削除 |
Add CC |
チケット通知CC追加 |
Delete CC |
チケット通知CC削除 |
Add Admin CC |
チケット通知Admin CC追加 |
Delete Admin CC |
チケット通知Admin CC削除 |
Change Owner |
対応者変更 |
Change Queue |
チケットキュー変更 |
Change Status |
ステータス変更 |
Subject Change |
件名変更 |
"action" Parameter List
Value |
Description |
CREATE |
変更要求作成 |
UPDATE |
変更要求更新 |
SUBMIT_FOR_APPROVAL |
変更要求起案 |
APPROVE |
変更要求承認 |
REJECT |
変更要求拒否 |
IMPLEMENT |
実装完了 |
SIGN_OFF |
変更要求クローズ |
MARK_AS_ROLLED_BACK |
切り戻し実施 |
EXECUTE_LINK |
関連自動化スクリプト実施 |
COMPLETE_LINK |
関連自動化スクリプト完了 |
SPAWN_RFC |
派生変更要求起案 |
SPAWN_COMPLETE |
派生変更要求完了 |
CANCEL |
変更要求キャンセル |
Example Response
{
"ticketTransaction": [
{
"actor": "sampleuser",
"actionDate": 1465277460000,
"actionType": "Create",
"post": "RFC Link: https://HOSTNAME/IPcm/rfc.htm?rfcID=1234\n\nSUBMITTED FOR APPROVAL on Tue Jun 07 05:31:00 UTC 2016 by Sample User (sampleuser) (Sample)\n\nRFC Details:\n\nName: Test for Change in Subject\nWorkflow: test-workflow\nInitiator: Sample User (sampleuser)\nPriority: NORMAL\nAttached Files: {azure_7.png}\n\n\nImplementation Start Time: Tue Jun 07 23:50:00 UTC 2016\nImplementation End Time: Wed Jun 08 23:50:00 UTC 2016\n\n\nSummary: \n\n\n\n\n----------------------\nTracking ID:[16][gsoduat]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1465277464000,
"actionType": "Add Log",
"post": "Attachment added: azure_7.png",
"oldValue": null,
"newValue": null,
"attachments": [
{
"attachmentName": "azure_7.png",
"attachmentID": 54
}
]
},
{
"actor": "sampleuser",
"actionDate": 1465277464000,
"actionType": "Add Log",
"post": "SUBMITTED FOR APPROVAL on Tue Jun 07 05:31:04 UTC 2016 by Sample User (sampleuser) (Sample)\n\nThe following updates were made to the request:\n\nStatus field was modified from [DRAFT] to [PENDING]\nActors field was modified from to [Sample Admin (sampleadmin) (GMOne) Sample User (sampleuser) (Sample) ]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1472101153000,
"actionType": "Add Log",
"post": "APPROVED on Thu Aug 25 04:59:12 UTC 2016 by Sample User (sampleuser) (Sample)\n\nThe following updates were made to the request:\n\nStatus field was modified from [PENDING] to [APPROVED]\nActors field was modified from to [Sample Admin (sampleadmin) (GMOne) Sample User (sampleuser) (Sample) ]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1472101173000,
"actionType": "Add Log",
"post": "UPDATED on Thu Aug 25 04:59:33 UTC 2016 by Sample User (sampleuser) (Sample)\n\nThe following updates were made to the request:\n\nActual Start Date field was modified from [null] to [Wed Aug 24 14:29:00 UTC 2016]\nActual End Date field was modified from [null] to [Thu Aug 25 14:29:00 UTC 2016]\nClosure Code field was modified from [null] to [SUCCESSFUL]\nActors field was modified from to [Sample Admin (sampleadmin) (GMOne) Sample User (sampleuser) (Sample) ]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1472101179000,
"actionType": "Add Log",
"post": "IMPLEMENTED on Thu Aug 25 04:59:39 UTC 2016 by Sample User (sampleuser) (Sample)\n\nThe following updates were made to the request:\n\nStatus field was modified from [APPROVED] to [IMPLEMENTED]\nActors field was modified from to [Sample Admin (sampleadmin) (GMOne) Sample User (sampleuser) (Sample) ]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1472101200000,
"actionType": "Add Log",
"post": "SIGNED OFF on Thu Aug 25 05:00:00 UTC 2016 by Sample User (sampleuser) (Sample)\n\nClosure Code: SUCCESSFUL\n\nThe following updates were made to the request:\n\nStatus field was modified from [IMPLEMENTED] to [CLOSED]\nActors field was modified from to [Sample Admin (sampleadmin) (GMOne) Sample User (sampleuser) (Sample) ]\n",
"oldValue": null,
"newValue": null,
"attachments": null
},
{
"actor": "sampleuser",
"actionDate": 1472101200000,
"actionType": "Status Change",
"post": "",
"oldValue": "open",
"newValue": "resolved",
"attachments": null
}
],
"rfcLog": [
{
"created": 1465276884000,
"user": "sampleuser",
"action": "CREATE"
},
{
"created": 1465277129000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Attached Files",
"oldValue": "[empty]",
"newValue": "{azure_7.png}"
}
]
},
{
"created": 1465277464000,
"user": "sampleuser",
"action": "SUBMIT_FOR_APPROVAL",
"diff": []
},
{
"created": 1465277464000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Status",
"oldValue": "DRAFT",
"newValue": "PENDING"
}
]
},
{
"created": 1472101152000,
"user": "sampleuser",
"action": "APPROVE",
"diff": []
},
{
"created": 1472101152000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Status",
"oldValue": "PENDING",
"newValue": "APPROVED"
}
]
},
{
"created": 1472101173000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Actual Start Date",
"oldValue": "null",
"newValue": "2016-08-24 14:29:00.0"
},
{
"key": "Actual End Date",
"oldValue": "null",
"newValue": "2016-08-25 14:29:00.0"
},
{
"key": "Closure Code",
"oldValue": "null",
"newValue": "SUCCESSFUL"
}
]
},
{
"created": 1472101178000,
"user": "sampleuser",
"action": "IMPLEMENT",
"diff": []
},
{
"created": 1472101179000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Status",
"oldValue": "APPROVED",
"newValue": "IMPLEMENTED"
}
]
},
{
"created": 1472101200000,
"user": "sampleuser",
"action": "SIGN_OFF",
"diff": []
},
{
"created": 1472101200000,
"user": "sampleuser",
"action": "UPDATE",
"diff": [
{
"key": "Status",
"oldValue": "IMPLEMENTED",
"newValue": "CLOSED"
}
]
}
]
}
コミュニケーションログ添付ファイル一覧取得(変更要求チケットID指定)
GET /v1/gmone/cm/rfcs/${rfcID}/attachments
コミュニケーションログの添付ファイル一覧を、変更要求チケットIDを指定する形で取得します。
このAPIは、変更要求チケットに紐づけられたコミュニケーションログ(詳細は、上述変更要求チケットログ取得APIに関するセクションに記述されてます)の添付ファイルの一覧を取得するものです。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したい変更要求チケットIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/rfcs/1234/attachments
Response Parameters
Name |
Description |
Type |
attachmentName |
添付ファイル名 |
string |
attachmentID |
添付ファイルID |
number |
Example Response
[
{
"attachmentName": "ExampleFile.txt",
"attachmentID": 730
}
]
コミュニケーションログ添付ファイル取得(変更要求チケットID、添付ファイルID指定)
GET /v1/gmone/cm/rfcs/${rfcID}/attachments/${attachmentID}
コミュニケーションログへの添付ファイルを、添付ファイルのIDとその添付ファイルの存在するチケットのIDを指定する形で取得します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
参照したいチケットのIDを指定 |
number |
true |
attachmentID |
参照したい添付ファイルのIDを指定 |
number |
true |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
GET /v1/gmone/cm/rfcs/1234/attachments/730
Response Parameters
ありません。返り値は添付ファイルそのもので、Content-Typeは"application/octet-stream"です。
Example Response
これはテストファイルです。
変更要求チケット作成
POST /v1/gmone/cm/rfcs
変更要求チケットを、必要事項を記入し、作成します。
Request Parameters
Body
Top level
Name |
Description |
Type |
Mandatory |
Default value |
name |
件名 |
string |
true |
N/A |
workflow |
処理ワークフロー |
Object (workflow) |
true |
N/A |
client |
クライアントコード |
string |
true |
N/A |
initiator |
起票者ユーザー名 |
string |
false |
APIユーザーアカウント |
ccs |
更新通知送付先CCリスト |
string(comma separated value list) |
false |
empty |
plannedStartDate |
作業開始日時(予定) |
number(epoc milliseconds) |
### |
empty |
plannedEndDate |
作業終了日時(予定) |
number(epoc milliseconds) |
### |
empty |
summary |
概要 |
string |
### |
empty |
priority |
重要度 |
string (priority) |
### |
empty |
category |
分類 |
string (category) |
### |
empty |
reason |
要求理由 |
string |
### |
empty |
risks |
実装時リスク |
string |
### |
empty |
cost |
費用 |
string |
### |
empty |
benefits |
利点 |
string |
### |
empty |
consequences |
想定される結果 |
string |
### |
empty |
implementationSteps |
実装手順 |
string |
### |
empty |
serviceAffected |
影響を受けるサービス |
string |
### |
empty |
rollbackProcedure |
切り戻し手順 |
string |
### |
empty |
backoutStrategy |
取りやめ時計画 |
string |
### |
empty |
attributes |
カスタム属性リスト |
object array (attribute) |
### |
empty |
cis |
構成アイテムリスト |
object array (ci) |
### |
empty |
上記表において、Mandatoryの値が###
となっているパラメータについては、変更要求ワークフローの種類によって、当該パラメーターが使用可能かどうか、必須かどうかが異なります。
実際にどのパラメータが使用され、また必須であるかに関しては、変更要求ワークフロー情報取得APIから確認することができます。
リクエストボディとして使用されない値を入力してリクエストした場合、そのパラメータは無視され、処理が続行されます。
"workflow" structure
Name |
Description |
Type |
Mandatory |
Default value |
workflowID |
ワークフローID |
number |
true |
N/A |
name |
ワークフロー名 |
string |
false |
empty |
"attribute" structure
Name |
Description |
Type |
Mandatory |
Default value |
name |
属性名 |
string |
true |
N/A |
value |
属性値 |
string |
true |
N/A |
attributeについても、どのカスタム属性が作成時に使用可能か、必須であるかは、変更要求ワークフローによって異なります。
どのカスタム属性が使用され、まだ必須であるかに関しては、変更要求ワークフロー情報取得APIから確認することができます。
"ci" structure
Name |
Description |
Type |
Mandatory |
Default value |
ciID |
構成アイテムID |
number |
select |
empty |
ciName |
構成アイテム名 |
string |
select |
empty |
clientID |
所属クライアントID |
number |
false |
top levelのclientの内部ID |
client |
所属クライアントコード |
string |
false |
top levelのclientの値 |
上記パラメータに関しては、"ciID"と"ciName"のいずれかを必ず入力してください。同時に記入した場合、"ciID"が優先されます。
また、"client"と"clientID"を同時に記入した場合、"clientID"が優先されます。
"priority" Parameter List
Value |
Description |
LOW |
低 |
NORMAL |
中 |
HIGH |
高 |
URGENT |
緊急 |
"category" Parameter List
Value |
Description |
MARGINAL |
重要でない |
SUBSTANTIAL |
通常 |
CRITICAL |
最重要 |
Example Request
POST /v1/gmone/cm/rfcs
Request Body
{
"client": "example",
"name": "Sample RFC initiated via API",
"summary": "Example Summary",
"priority": "NORMAL",
"ccs": "dummy@example.com,dummy2@example.com",
"plannedStartDate": 1476806520000,
"plannedEndDate": 1476892920000,
"workflow": {
"workflowID": 9
},
"attributes": [
{
"name": "generic_boolean",
"value": "true"
},
{
"name": "generic_sample_input",
"value": "sample"
}
],
"cis": [
{
"ciName": "testdev.example",
"client": "example"
}
]
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
rfc |
変更要求チケットID |
number |
Example Response
{
"result": "created",
"rfc": 2345
}
変更要求チケットへのファイル添付
POST /v1/gmone/cm/rfcs/{rfcID}/files
変更要求チケットに、ファイルを添付します。なおこのAPIは該当の変更要求チケットのステータスがDRAFT
であるかPENDING
である場合のみ利用できます。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
ファイル添付したい変更要求チケットIDを指定 |
number |
true |
Body
このAPIのbodyのCotent-Type
はmultipart/form-data
です。
また下記attachment
は複数指定することができ、複数ファイルのアップロードが可能です。
Name |
Description |
Type |
Mandatory |
Default value |
attachment |
添付ファイル実体 |
blob(base64-encoded) |
true |
N/A |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
PUT /v1/gmone/cm/rfcs/1234/files
Request Body
curl -X POST -H "Authorization: Basic c3RhdGVpc2hpOlN6c2RocmdoQDE5OTM=" \
-H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \
-F "attachment=@testfile.txt" -F "attachment=@yet_another_testfile.jpg" \
"https://api.ntt.com/v1/gmone/cm/rfcs/3262/files"
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
rfc |
変更要求チケットID |
number |
Example Response
JSON
{
"result": "file has been attached",
"rfc": 1234
}
変更要求チケット更新
PUT /v1/gmone/cm/rfcs/{rfcID}
変更要求チケットの内容を更新します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
更新したい変更要求チケットIDを指定 |
number |
true |
Body
このAPIは、変更要求チケットのワークフローの処理状態によって更新できるデータが変わります。
それぞれ処理できるデータは以下の通りです。
DRAFT / PENDING時
Top level
Name |
Description |
Type |
Mandatory |
Default value |
name |
件名 |
string |
true |
N/A |
ccs |
更新通知送付先CCリスト |
string(comma separated value list) |
false |
empty |
plannedStartDate |
作業開始日時(予定) |
number(epoc milliseconds) |
### |
empty |
plannedEndDate |
作業終了日時(予定) |
number(epoc milliseconds) |
### |
empty |
summary |
概要 |
string |
### |
empty |
priority |
重要度 |
string (priority) |
### |
empty |
category |
分類 |
string (category) |
### |
empty |
reason |
要求理由 |
string |
### |
empty |
risks |
作業時リスク |
string |
### |
empty |
cost |
費用 |
string |
### |
empty |
benefits |
利点 |
string |
### |
empty |
consequences |
想定される結果 |
string |
### |
empty |
implementationSteps |
実装手順 |
string |
### |
empty |
serviceAffected |
影響を受けるサービス |
string |
### |
empty |
rollbackProcedure |
切り戻し手順 |
string |
### |
empty |
backoutStrategy |
取りやめ時計画 |
string |
### |
empty |
attributes |
カスタム属性リスト |
object array (attribute) |
### |
empty |
cis |
構成アイテムリスト |
object array (ci) |
### |
empty |
上記表において、Mandatoryの値が###
となっているパラメータについては、変更要求ワークフローの種類によって、当該パラメーターが使用可能かどうか、必須かどうかが異なります。
実際にどのパラメータが使用され、また必須であるかに関しては、変更要求ワークフロー情報取得APIから確認することができます。
リクエストボディとして使用されない値を入力してリクエストした場合、そのパラメータは無視され、処理が続行されます。
"attribute" structure
Name |
Description |
Type |
Mandatory |
Default value |
name |
属性名 |
string |
true |
N/A |
value |
属性値 |
string |
true |
N/A |
attributeについても、どのカスタム属性が作成時に使用されるか、必須であるかは、変更要求ワークフローによって異なります。
どのカスタム属性が使用され、また必須であるかに関しては、変更要求ワークフロー情報取得APIから確認することができます。
なお、DRAFT/PENDING時に利用できるカスタム属性は、ワークフロー情報取得API中のrfcSection
の値がAssessment
のものです。
"ci" structure
Name |
Description |
Type |
Mandatory |
Default value |
ciID |
構成アイテムID |
number |
select |
empty |
ciName |
構成アイテム名 |
string |
select |
empty |
client |
所属クライアントコード |
string |
false |
top levelのclientの値 |
clientID |
所属クライアントID |
number |
false |
top levelのclientのID |
上記パラメータに関しては、"ciID"と"ciName"のどちらかを必ず入力してください。同時に記入した場合、"ciID"が優先されます。
また、"client"と"clientID"を同時に記入した場合、"clientID"が優先されます。
"priority" Parameter List
Value |
Description |
LOW |
低 |
NORMAL |
中 |
HIGH |
高 |
URGENT |
緊急 |
"category" Parameter List
Value |
Description |
MARGINAL |
重要でない |
SUBSTANTIAL |
通常 |
CRITICAL |
最重要 |
PENDING時のみ
Name |
Description |
Type |
Mandatory |
Default value |
approvalNotes |
承認時特記事項 |
string |
false |
empty |
rejectionNotes |
否認時特記事項 |
string |
false |
empty |
またattributeについて、PENDING時にはワークフロー情報取得API中のrfcSection
の値がAssessment
のものに加えて、Authorization
のものも利用できます。
APPROVED時のみ
Name |
Description |
Type |
Mandatory |
Default value |
closureDate |
クローズ日時 |
number(epoc milliseconds) |
false |
empty |
APPROVED/IMPLEMENTED時
Top level
Name |
Description |
Type |
Mandatory |
Default value |
actualStartDate |
作業開始日時(実績) |
number(epoc milliseconds) |
false |
empty |
implementationDate |
作業終了日時(実績) |
number(epoc milliseconds) |
false |
empty |
vendorImplementationTime |
実作業時間 |
number |
false |
empty |
implementationEffort |
実装時稼働 |
string |
false |
empty |
userTestsComplete |
ユーザーテスト完了日時 |
number(epoc milliseconds) |
false |
empty |
acceptanceTestsComplete |
受け入れテスト完了日時 |
number(epoc milliseconds) |
false |
empty |
operationTestsComplete |
運用準備テスト完了日時 |
number(epoc milliseconds) |
false |
empty |
objectiveAchieved |
実装時結果の詳細 |
string |
false |
empty |
findings |
実装時特記事項 |
string |
false |
empty |
closureCode |
クローズ時分類 |
string (下記参照) |
false |
empty |
attributes |
カスタム属性リスト |
object array (attribute) |
### |
empty |
"attribute" structure
Name |
Description |
Type |
Mandatory |
Default value |
name |
属性名 |
string |
true |
N/A |
value |
属性値 |
string |
true |
N/A |
APPROVED/IMPLEMENTED時に利用できるカスタム属性は、ワークフロー情報取得API中のrfcSection
の値がImplementation
、Closure
のものです。
"closureCode" Parameter List
Value |
Description |
SUCCESSFUL |
実装成功 |
SUCCESSFUL_WITH_ISSUES |
実装成功だが残余課題あり |
ROLLED_BACK |
切り戻し |
CANCELLED |
実装キャンセル |
CLOSED_IN_DRAFT |
承認要求されずにクローズした |
PARTIALLY_IMPLEMENTED |
部分的に実装 |
PARTIALLY_ROLLED_BACK |
部分的に切り戻し |
FAILED |
実装失敗 |
CLOSED/FAILED時
該当する変更要求チケットのアップデートはできません。
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
PUT /v1/gmone/cm/rfcs/1234
Request Body
{
"name": "Example RFC subject modification",
"attributes": [
{
"name": "generic_boolean",
"value": "false"
}
]
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
rfc |
変更要求チケットID |
number |
Example Response
{
"result": "updated",
"ticketId": 1234
}
変更要求チケット処理
PUT /v1/gmone/cm/rfcs/{rfcID}/status
変更要求チケットを、ワークフローに従って処理します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
処理したい変更要求チケットIDを指定 |
number |
true |
Body
Name |
Description |
Type |
Mandatory |
Default value |
operation |
処理種別 |
string (operation) |
true |
N/A |
"operation" Parameter List
Value |
Description |
submit |
起案 |
approve |
承認 |
reject |
拒否 |
implement |
実装完了 |
close |
クローズ |
cancel |
キャンセル |
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
requestor |
実行ユーザー |
string |
false |
Empty |
Example Request
PUT /v1/gmone/cm/rfcs/1234/status
Request Body
{
"operation": "submit"
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
rfc |
変更要求チケットID |
number |
Example Response
{
"result": "status changed",
"ticketId": 1234
}
コミュニケーションログ追記
POST /v1/gmone/cm/rfcs/${rfcId}/log
コミュニケーションログを追記します。
Request Parameters
URL Path Parameter
Name |
Description |
Type |
Mandatory |
rfcID |
ログ追記したい変更要求チケットIDを指定 |
number |
true |
Body
Name |
Description |
Type |
Mandatory |
Default value |
post |
ログ本文 |
string |
true |
N/A |
poster |
ログ投稿者 |
string |
false |
APIユーザーアカウント |
onetimeCc |
通知CCメールアドレス |
string |
false |
Empty |
onetimeBcc |
通知BCCメールアドレス |
string |
false |
Empty |
attachments |
添付ファイル情報 |
Object array (attachements) |
false |
Empty |
"attachements" Object List
Name |
Description |
Type |
Mandatory |
Default value |
name |
添付ファイル名 |
string |
true |
N/A |
content |
添付ファイルの内容 |
string (Base64 Encoded Binary) |
true |
N/A |
Example Request
POST /v1/gmone/cm/rfcs/1234
Request Body
{
"post": "example",
"poster": "example",
"onetimeCc": ["example@example.com"],
"onetimeBcc": ["example@example.com"],
"attachments": [{
"name": "example.txt",
"content": "44GT44KM44Gv44OG44K544OI44OV44Kh44Kk44Or44Gn44GZ44CC"
}]
}
Response Parameters
Name |
Description |
Type |
result |
結果 |
string |
rfc |
変更要求チケットID |
number |
Example Response
{
"result": "success",
"rfc": 1234
}
構成管理DB情報取得API
GET /v1/gmone/cmdb/
Global Management OneポータルのIPcmdbモジュールから、お客様のシステム環境の構成情報を取得します。
構成アイテムの詳細や、構成アイテム間の関連性に関する情報が取得できます。
CI(構成アイテム)タイプ取得
GET /v1/gmone/cmdb/citypes
現在のクライアントが持つCIタイプを取得します。
複数のクライアントを持つお客様の場合、クライアントコードを指定することでさらに結果を絞り込むことができます。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
False |
name |
CIタイプ名を指定 (globによる表現に対応) |
query argument |
False |
Example Request
GET /v1/gmone/cmdb/citypes?client=GMOne_QA&name=Device*
Response Parameters
Name |
|
Description |
type |
ciTypeID |
|
CIタイプID |
Int |
name |
|
CIタイプ名 |
String |
nameValidationPattern |
|
所属CI命名規則 |
String with regular expression |
nameValidationDescription |
|
所属CI命名規則の解説 |
String |
parentCIType |
|
継承元CIタイプ名 |
String |
global |
|
どのClientにも共通のCIタイプか |
bool |
incomingAssociations |
|
このCIが設定される側のアソシエーションタイプ情報 |
Object array |
|
name |
アソシエーションタイプ名 |
String |
|
associationTypeID |
アソシエーションタイプID |
Int |
|
sourceCIType |
Source側CIタイプ |
String |
|
targetCIType |
Target側CIタイプ |
String |
|
sourceRoleDescription |
Source側の位置づけ |
String |
|
targetRoleDescription |
Target側の位置づけ |
String |
|
multiplicityType |
両端ノードの重複度 |
String |
|
abstract |
このアソシエーションタイプは抽象クラスか(実際にアソシエーション情報を持つか) |
bool |
outgoingAssociations |
incomingAssociationsに同じ |
このCIから設定する側のアソシエーションタイプ情報 |
Object array |
attributes |
|
CIタイプ固有属性の定義 |
Object array |
|
attribute |
属性定義名 |
String |
|
description |
属性定義の解説 |
Int |
|
ciType |
この属性を所有するCIタイプ |
Int |
|
enabled |
属性として有効か |
bool |
|
multiple |
この属性値は一つのCIに複数回設定されうるか |
bool |
|
required |
この属性値は必須か |
bool |
|
secured |
この属性値は伏字で処理されるか |
bool |
|
dataType |
属性値のデータ型 |
String |
|
(selectList) |
この属性の値がリストで限定される場合の、データリストに関する情報、詳細は下記 |
object |
inheritedAttributes |
attributesに同じ |
親のCIタイプから継承された属性の定義 |
Object array |
abstract |
|
このCIタイプは抽象クラスか(実際にCIを持つか) |
bool |
selectListのオブジェクトマッピング
Name |
Description |
type |
name |
データリスト名 |
String |
datumType |
リストアイテムのデータ型 |
String |
autoSort |
表示時自動的にソートするか |
bool |
options |
データリスト本体 |
typeOf(datumType) array |
Example Result
[
{
"ciTypeID": 4,
"name": "Device",
"nameValidationPattern": "([a-z0-9_\-]+\.)+[a-z0-9_\-]{2,}",
"nameValidationDescription": "Lowercase 'a-z', '0-9', '-', '_', or '.', followed by .clientcode (ex. foo_123.ipsoft)",
"parentCIType": "Computer System",
"global": True,
"incomingAssociations": [
{
"name": "Base Location Association",
"associationTypeID": 1,
"sourceCIType": "Base CI",
"targetCIType": "Base CI",
"sourceRoleDescription": "Location",
"targetRoleDescription": "CIs",
"multiplicityType": "ManyToOne",
"abstract": True
}, ......
],
"outgoingAssociations": [
{
"name": "Base Location Association",
"associationTypeID": 1,
"sourceCIType": "Base CI",
"targetCIType": "Base CI",
"sourceRoleDescription": "Location",
"targetRoleDescription": "CIs",
"multiplicityType": "ManyToOne",
"abstract": True
}, ......
],
"attributes": [
{
"attribute": "Type",
"description": "Generic type field - serves as a CI type sub-categorization",
"ciType": "Device",
"enabled": True,
"multiple": False,
"required": True,
"secured": False,
"dataType": "String",
"selectList": {
"name": "Device Types",
"datumType": "String",
"autoSort": True,
"options": [
"Appliance",
"Application Switch",
"Chassis",
"Cloud",
"Concentrator",
"Firewall",
"Gateway",
"Hypervisor",
"Module",
"Network",
"PC",
"Power",
"Router",
"SAN Switch",
"SAN/NAS",
"Server",
"Switch",
"VoiceGateway",
"VoiceMail",
"Wireless",
"_Other_"
]
}
}, ......
],
"inheritedAttributes": [
{
"attribute": "Description",
"description": "Description of CI",
"ciType": "Base CI",
"enabled": True,
"multiple": False,
"required": False,
"secured": False,
"dataType": "Text"
}, ......
],
"abstract": False
}
]
CI(構成アイテム)取得
GET /v1/gmone/cmdb/cis
現在のクライアントに所属するCIを取得します。
Site(CIの所属)やCI名などを指定することで、結果をさらに絞り込むことができます。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
site |
CIの所属するSiteの名前を指定 |
query argument |
False |
name |
CI名を指定 (globによる表現に対応) |
query argument |
False |
type |
CIタイプを指定 |
query argument |
True |
serviceChecks |
CIが監視対象として持っているサービス名を指定 |
query argument |
False |
Example Request
GET /v1/gmone/cmdb/cis?client=GMOne_QA&type=Device&name=gmone*
Response Parameters
Name |
|
Description |
type |
clientID |
|
所属するClientのID |
Int |
clientName |
|
Client名 |
String |
created |
|
作成日時 |
Unix time in millisecond |
id |
|
CIのID |
Int |
name |
|
CI名 |
String |
typeID |
|
CIタイプID |
Int |
typeName |
|
CIタイプ名 |
String |
updated |
|
最終更新日時 |
Unix time in millisecond |
Attributes |
|
CI固有属性値 |
Object array |
|
datumType |
属性のデータ型 |
String |
|
definitionID |
属性定義ID |
Int |
|
id |
属性ID |
Int |
|
name |
属性名 |
String |
|
content |
属性値 |
String |
outgoingAssociations |
詳細は下記参照 |
このCIから設定する側のアソシエーション情報 |
Object array |
incomingAssociations |
詳細は下記参照 |
このCIが設定される側のアソシエーション情報 |
Object array |
アソシエーション情報のパラメータ(outgoingAssociations, incomingAssociations)
Name |
|
Description |
type |
typeName |
|
アソシエーションタイプ名 |
String |
multiplicity |
|
ノードの重複度 |
String |
typeID |
|
アソシエーションタイプID |
Int |
CI |
|
アソシエーション情報に紐づく構成アイテム(以下CI) |
Object array |
|
clientID |
CIの所属するクライアントのID |
Int |
|
clientName |
CIの所属するクライアント名 |
String |
|
created |
CIの作成日時 |
Unix time in millisecond |
|
id |
CIのID |
Int |
|
name |
CI名 |
String |
|
typeID |
CIタイプID |
Int |
|
typeName |
CIタイプ名 |
String |
|
updated |
CIの最終更新日時 |
Unix time in millisecond |
|
associationRank |
アソシエーション同士の重み付け係数 |
Int |
Example Result
[
{
"clientID": "88",
"clientName": "GMOne_QA",
"created": "1434530569000",
"id": "3878",
"name": "gmoneqahost.windows01.gmone_qa",
"typeID": "4",
"typeName": "Device",
"updated": "1434702121000",
"Attributes": [
{
"datumType": "Text",
"definitionID": "2",
"id": "26222",
"name": "Description",
"content": "Windows Server for QA"
},
{
"datumType": "Boolean",
"definitionID": "15",
"id": "26223",
"name": "Monitored",
"content": "True"
},
{
"datumType": "Boolean",
"definitionID": "215",
"id": "26224",
"name": "GMOne Managed",
"content": "True"
},
{
"datumType": "Boolean",
"definitionID": "54",
"id": "26225",
"name": "Managed",
"content": "True"
},
{
"datumType": "String",
"definitionID": "55",
"id": "26226",
"name": "Monitored Address",
"content": "153.149.11.90"
},
{
"datumType": "String",
"definitionID": "12",
"id": "26227",
"name": "Type",
"content": "Server"
},
{
"datumType": "String",
"definitionID": "21",
"id": "26228",
"name": "OS Type",
"content": "Windows"
},
{
"datumType": "String",
"definitionID": "22",
"id": "26229",
"name": "OS Sub-Type",
"content": "Windows Server 2008 R2"
},
{
"datumType": "String",
"definitionID": "23",
"id": "26230",
"name": "OS Version",
"content": "6.1.7601"
},
{
"datumType": "String",
"definitionID": "13",
"id": "26262",
"name": "Status",
"content": "Active"
}
],
"OutgoingAssociations": [
{
"typeName": "Device Site",
"multiplicity": "ManyToOne",
"typeID": "3",
"CI": [
{
"clientID": "88",
"clientName": "GMOne_QA",
"created": "1428921085000",
"id": "3174",
"name": "JPNCloudN",
"typeID": "3",
"typeName": "Site",
"updated": "1428921085000",
"associationRank": "10"
}
]
}
],
"IncomingAssociations": [
{
"typeName": "Contact to BaseCI",
"multiplicity": "ManyToMany",
"typeID": "10",
"CI": [
{
"clientID": "88",
"clientName": "GMOne_QA",
"created": "1433736534000",
"id": "3695",
"name": "Customer 01",
"typeID": "12",
"typeName": "Contact",
"updated": "1436935399000",
"associationRank": "10"
}
]
}
]
}
]
CI(構成アイテム)間アソシエーション情報取得(クライアントコード、アソシエーションタイプ名指定型)
GET /v1/gmone/cmdb/associations/spec
CI間の関連に関する情報を取得できます。
こちらのAPIでは、所属するクライアントコードとアソシエーションの種類を指定することで検索を行います。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
type |
検索対象のアソシエーションタイプを指定 |
query argument |
True |
limit |
表示制限数を指定 |
query argument |
False |
Example Request
GET v1/gmone/cmdb/associations/spec?client=GMOne_QA&type=Device Site&limit=1
Response Parameters
Name |
|
Description |
type |
typeName |
|
アソシエーションタイプ名 |
String |
multiplicity |
|
ノードの重複度 |
String |
typeID |
|
アソシエーションタイプID |
Int |
CI |
|
アソシエーション情報に紐づく構成アイテム(以下CI) |
Object array |
|
clientID |
CIの所属するクライアントのID |
Int |
|
clientName |
CIの所属するクライアント名 |
String |
|
created |
CIの作成日時 |
Unix time in millisecond |
|
id |
CIのID |
Int |
|
name |
CI名 |
String |
|
typeID |
CIタイプID |
Int |
|
typeName |
CIタイプ名 |
String |
|
updated |
CIの最終更新日時 |
Unix time in millisecond |
|
associationRank |
アソシエーション同士の重み付け係数 |
Int |
Example Result
[
{
"typeName": "Device Site",
"multiplicity": "ManyToOne",
"typeID": "3",
"CI": {
"clientID": "88",
"clientName": "GMOne_QA",
"created": "1434000645000",
"id": "5523",
"name": "devoaacer02.gmone_qa",
"typeID": "4",
"typeName": "Device",
"updated": "1434531105000",
"associationRank": "0"
}
}
]
CI(構成アイテム)間アソシエーション情報取得(CI指定型)
GET /v1/gmone/cmdb/associations/node
CI間の関連に関する情報を取得できます。
こちらのAPIでは、所属するクライアントと関連性の両端を構成するCIに関する情報を指定することで検索を行います。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
sourceType |
Source側のCIタイプを指定 |
query argument |
True |
soureName |
Source側のCI名を指定 (globによる表現に対応) |
query argument |
True |
targetType |
Target側のCIタイプを指定 |
query argument |
True |
targetName |
Target側のCI名を指定 (globによる表現に対応) |
query argument |
False |
limit |
表示制限数を指定 |
query argument |
False |
Example Request
GET /v1/gmone/cmdb/associations/node?client=GMOne_QA&sourceType=Device&sourceName=*&targetType=Site&targetName=*&limit=1
Response Parameters
Name |
|
Description |
type |
typeName |
|
アソシエーションタイプ名 |
String |
multiplicity |
|
ノードの重複度 |
String |
typeID |
|
アソシエーションタイプID |
Int |
CI |
|
アソシエーション情報に紐づく構成アイテム(以下CI) |
Object array |
|
clientID |
CIの所属するクライアントのID |
Int |
|
clientName |
CIの所属するクライアント名 |
String |
|
created |
CIの作成日時 |
Unix time in millisecond |
|
id |
CIのID |
Int |
|
name |
CI名 |
String |
|
typeID |
CIタイプID |
Int |
|
typeName |
CIタイプ名 |
String |
|
updated |
CIの最終更新日時 |
Unix time in millisecond |
|
associationRank |
アソシエーション同士の重み付け係数 |
Int |
Example Result
[
{
"typeName": "Device Site",
"multiplicity": "ManyToOne",
"typeID": "3",
"CI": {
"clientID": "88",
"clientName": "GMOne_QA",
"created": "1434000645000",
"id": "5523",
"name": "devoaacer02.gmone_qa",
"typeID": "4",
"typeName": "Device",
"updated": "1434531105000",
"associationRank": "0"
}
}
]
監視対象情報取得API
GET /v1/gmone/admin/
Global Management One ポータルのIPadminモジュールから、監視登録されている機器の情報を取得します。
監視状況を参照する際に、このAPIを使用することで検索対象のホスト名を取得できます。
監視対象ホスト情報取得
GET /v1/gmone/admin/hosts
現在のクライアントに登録されている監視中のホストの情報を取得します。
複数のクライアントを持つお客様の場合、クライアントコードを指定することでさらに結果を絞り込むことができます。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 (globによる表現に対応) |
query argument |
True |
name |
ホスト名を指定 (globによる表現に対応) |
query argument |
False |
Example Request
GET /v1/gmone/admin/hosts?client=GMOne_QA&name=gmoneqahost.gmone*
Response Parameters
Name |
|
Description |
type |
name |
|
ホスト名 |
String |
alias |
|
ホスト名の別名 |
String |
created |
|
監視登録を行った日時 |
Unix time in millisecond |
updated |
|
最終更新日時 |
Unix time in millisecond |
notificationOptions |
|
通知を行う監視状態#3 |
String array |
serviceChecks |
|
監視対象サービス |
object array |
|
name |
サービス名 |
String |
|
description |
サービス表示名 |
String |
|
deleted |
監視対象から削除しているか |
bool |
#3:
Value |
Description |
UP |
正常 |
DOWN |
接続断 |
UNREACHABLE |
監視不能 |
RECOVERY |
障害から回復 |
DOWNTIME |
メンテナンス中 |
FLAPPING |
UP / DOWN を短期間に繰り返している |
Example Result
[
{
"name": "gmoneqahost.gmone_qa",
"alias": "gmoneqahost.gmone_qa",
"created": 1436400249000,
"updated": 1438654791000,
"notificationOptions": [
"UP",
"DOWN",
"UNREACHABLE",
"RECOVERY",
"DOWNTIME"
],
"serviceChecks": [
{
"name": "GM1 System Memory Unix",
"description": "System Memory",
"deleted": False
}, ....
]
}
]
監視情報取得API
GET /v1/gmone/mon/
Global Managemant One ポータルのIPmonモジュールから監視対象機器についての情報を取得します。
監視対象機器のステータス及び、それら機器のメンテナンス予定情報についても取得することができます。
ホスト状態取得
GET /v1/gmone/mon/host/status
クライアントを指定し、監視中のホストの状態を取得します。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
host |
ホスト名を指定 |
query argument |
True |
Example Request
GET /v1/gmone/mon/host/status?client=GMOne_QA&host=gmoneqahost.gmone_qa
Response Parameters
Name |
|
Description |
type |
hostName |
|
ホスト名 |
String |
hostGroups |
|
ホストの所属するグループ名 |
String |
lastStateChange |
|
最後に監視状態が変わった日時 |
Unix time in millisecond |
lastUpdate |
|
監視状態の最終更新日時 |
Unix time in millisecond |
checkLatency |
|
検知の適正時間とのずれ |
double (second) |
checkExecutionTime |
|
検知にかかった時間 |
double (second) |
output |
|
結果 |
String |
longOutput |
|
結果の詳細 |
String |
state |
|
監視状態 |
String |
lastTimeUp |
|
最後に正常状態だった日時 |
Unix time in millisecond |
lastTimeDown |
|
最後に接続断状態だった日時 |
Unix time in millisecond |
lastTimeUnrechable |
|
最後に到達不能だった日時 |
Unix time in millisecond |
perfData |
|
監視結果の具体値 |
String |
downtime |
|
メンテナンス中か |
bool |
Example Result
[
{
"hostName": "gmoneqahost.gmone_qa",
"hostGroups": "GMOne_QA-JPNCloudN",
"lastStateChange": 1440488203000,
"lastUpdate": 1441178705000,
"checkLatency": 0.076,
"checkExecutionTime": 0.046,
"output": "fping 153.128.39.158 rtt: 113 ms",
"longOutput": null,
"state": "UP",
"lastTimeUp": 1441178575000,
"lastTimeDown": 1440488021000,
"lastTimeUnrechable": null,
"perfData": null,
"downtime": False
}
]
メンテナンス予定情報取得(ホスト)
GET /v1/gmone/mon/host/downtime
クライアントを指定し、監視中のホストのメンテナンス予定情報を取得します。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
host |
ホスト名を指定 |
query argument |
True |
Example Request
GET /v1/gmone/mon/host/downtime?client=GMOne_QA&host=gmoneqahost.gmone_qa
Response Parameters
Name |
|
Description |
type |
hostName |
|
ホスト名 |
String |
downtimeId |
|
メンテナンス登録ID |
Int |
entryTime |
|
メンテナンス登録日時 |
Unix time in millisecond |
startTime |
|
メンテナンス開始日時 |
Unix time in millisecond |
endTime |
|
メンテナンス終了日時 |
Unix time in millisecond |
triggeredBy |
|
このメンテナンスの開始要因となるメンテナンス登録ID |
Int |
fixed |
|
開始、終了を決めて通知を停止するか(True)、接続断を検知した後に指定された秒数通知を停止するか(False) |
bool |
duration |
|
メンテナンスの継続時間 |
Int (second) |
author |
|
メンテナンス情報登録者 |
String |
comment |
|
登録時のコメント |
String |
Example Result
[
{
"hostName": "gmoneqahost.gmone_qa",
"downtimeId": 2,
"entryTime": 1440480001000,
"startTime": 1440480109000,
"endTime": 1440487429000,
"triggeredBy": 0,
"fixed": True,
"duration": 7320,
"author": "stateishi",
"comment": "test"
}
]
サービス監視結果概要取得
GET /v1/gmone/mon/service/summary
クライアントを指定し、監視中のサービスの監視結果の概要を取得します。
正常/異常なサービスの数や、サービス全体に対する正常なサービスの割合などの健康状態を見ることができます。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
Example Request
GET /v1/gmone/mon/service/summary?client=GMOne_QA
Response Parameters
Name |
|
Description |
type |
pending |
|
監視保留状態のサービスの数 |
Int |
critical |
|
異常検知状態のサービス数 |
Int |
ok |
|
正常なサービスの数 |
Int |
unknown |
|
状態不明のサービスの数 |
Int |
warning |
|
警告状態のサービスの数 |
Int |
serviceHealth |
|
全サービスに対する正常なサービスの割合(パーセンテージ) |
Int |
Example Result
[
{
"pending": 0,
"critical": 0,
"ok": 33,
"unknown": 0,
"warning": 0,
"serviceHealth": 100
},
{
"pending": 0,
"critical": 0,
"ok": 37,
"unknown": 10,
"warning": 0,
"serviceHealth": 78.72
},
{
"pending": 0,
"critical": 0,
"ok": 10,
"unknown": 0,
"warning": 0,
"serviceHealth": 100
}
]
```
監視対象ホスト監視結果概要取得
GET /v1/gmone/mon/host/summary
クライアントを指定し、監視中のホストの監視結果の概要を取得します。
正常/異常なホストの数や、ホスト全体に対する正常なホストの割合などの健康状態を見ることができます。
Request Parameters
Name |
Description |
type |
mandatory |
client |
検索対象のクライアントコードを指定 |
query argument |
True |
Example Request
GET /v1/gmone/mon/host/summary?client=GMOne_QA
Response Parameters
Name |
|
Description |
type |
empty |
|
監視対象が存在しない場合、True |
bool |
up |
|
正常なホストの数 |
Int |
down |
|
断状態のホストの数 |
Int |
unreachable |
|
到達不能のホストの数 |
Int |
pending |
|
監視保留状態のホストの数 |
Int |
hostHealth |
|
全ホストに対する正常なホストの割合(パーセンテージ) |
Int |
Example Result
[
{
"empty": False,
"up": 2,
"down": 0,
"unreachable": 0,
"pending": 0,
"hostHealth": 100
},
{
"empty": False,
"up": 2,
"down": 0,
"unreachable": 0,
"pending": 0,
"hostHealth": 100
},
{
"empty": False,
"up": 1,
"down": 0,
"unreachable": 0,
"pending": 0,
"hostHealth": 100
}
]
パフォーマンスレポートAPI
/v1/gmone/reports/
Global Management One システムより、パフォーマンスレポートに関する情報を取得します。
パフォーマンスレポート項目取得(ホスト名指定)
GET /v1/gmone/reports/services?host=hostname
パフォーマンスレポートの項目一覧を、対象のホスト名を指定する形で絞り込み、検索します。
Request Parameters
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
host |
ホスト名 |
string |
true |
N/A |
Example Request
GET /v1/gmone/reports/services?host=gmoneqahost.gmone_qa
Response Parameters
Name |
Description |
Type |
hostName |
ホスト名 |
string |
services |
サービス情報 |
Object Array |
services.serviceName |
サービス名 |
string |
services.metrics |
レポート項目情報 |
Object Array |
services.metrics.metricName |
レポート項目名 |
string |
Example Response
[
{
"hostName": "linux01.cmp",
"services": [
{
"serviceName": "Inodes - /boot",
"metrics": [
{
"metricName": "inodes_free"
},
{
"metricName": "inodes_used"
}
]
},
{
"serviceName": "Disk - /sys/fs/cgroup",
"metrics": [
{
"metricName": "disk_free"
},
{
"metricName": "disk_used"
}
]
},
{
"serviceName": "Inodes - /sys/fs/cgroup",
"metrics": [
{
"metricName": "inodes_free"
},
{
"metricName": "inodes_used"
}
]
}
]
}
]
パフォーマンスレポート取得(ホスト名、サービス名、レポート項目、対象時間、間隔指定)
GET /v1/gmone/reports/data?key=value
パフォーマンスレポートを、レポート対象項目や時間によって絞り込み、取得します。
Request Parameters
URL Query Parameter
Name |
Description |
Type |
Mandatory |
Default value |
host |
ホスト名 |
string |
true |
N/A |
service |
サービス名 |
string |
true |
N/A |
metric |
レポート項目名 |
string |
true |
N/A |
rollup |
プロット間隔 |
rollup |
true |
N/A |
from |
指定時間(以降) |
number(ミリ秒Unix時間) |
true |
N/A |
to |
指定時間(以前) |
number(ミリ秒Unix時間) |
true |
N/A |
'rollup' parameter list
Name |
Description |
remarks |
5m |
5分 |
35日間分保管 |
30m |
30分 |
45日間分保管 |
1h |
1時間 |
180日間分保管 |
4h |
4時間 |
一年分保管 |
12h |
12時間 |
一年分保管 |
1d |
一日 |
一年分以上保管 |
Example Request
GET /v1/gmone/reports/data?rollup=5m&from=1487041083000&to=1488041083000&host=linux01.cmp&service=Load Average&metric=load_average_5min
Response Parameters
下記レスポンスのフォーマットはtext/csv
です。
Name |
Description |
Type |
time |
観測日時(UTC) |
string |
value |
パフォーマンスデータ |
double |
Example Response
"time","value"
2017/02/14 02:55:00,0.02
2017/02/14 03:00:00,0.04
2017/02/14 03:05:00,0.01
2017/02/14 03:10:00,0.01
2017/02/14 03:15:00,0.01
2017/02/14 03:20:00,0.04
2017/02/14 03:25:00,0.01
2017/02/14 03:30:00,0.01
2017/02/14 03:35:00,0.01
2017/02/14 03:40:00,0.01
2017/02/14 03:45:00,0.01
2017/02/14 03:50:00,0.01
2017/02/14 03:55:00,0.01
...
2017/02/25 15:00:00,0.02
2017/02/25 15:05:00,0.01
2017/02/25 15:10:00,0.02
2017/02/25 15:15:00,0.01
2017/02/25 15:20:00,0.01
2017/02/25 15:25:00,0.02
2017/02/25 15:30:00,0.01
2017/02/25 15:35:00,0.02
2017/02/25 15:40:00,0.07
2017/02/25 15:45:00,0.04
2017/02/25 15:50:00,0.08
2017/02/25 15:55:00,0.09
2017/02/25 16:00:00,0.05
2017/02/25 16:05:00,0.02
2017/02/25 16:10:00,0.04
2017/02/25 16:15:00,0.04
2017/02/25 16:20:00,0.1
2017/02/25 16:25:00,0.08
2017/02/25 16:30:00,0.07
2017/02/25 16:35:00,0.06
2017/02/25 16:40:00,0.08