サービス申請を作成する
Rest API を使用して サービス申請を作成できます。
ベース URL:
https://{tenant url}/api/rest/ServiceRequest/new
サービス申請を作成する例を次に示します。
メールアドレス | https://{tenant url}/api/rest/ServiceRequest/new |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: JWT トークン/セッション キー/REST API キー |
リクエストペイロード | { "attachmentsToDelete": [], "attachmentsToUpload": [], 「パラメータ」: {}, "delayedFulfill": false, "formName": "ServiceReq.ResponsiveAnalyst.DefaultLayout", "saveReqState": 偽、 "serviceReqData": { 「件名」: 「RESTAPI からの SR」、 「詳細」: 「テスト02」 }, "strCustomerLocation": "西", "strUserId": "2F851094BFE5437C97D19871D1C539C7", "サブスクリプションID": "0C1780F4EC814CB2B8E045325D8CFB66", "ローカルオフセット": -330 } この例に示されているすべてのフィールドは必須であり、いずれかのフィールドが欠落している場合、API はエラーを返します。 ただし、Create Service Request API を実行すると、 attachmentsToDelete の値は空白になります。 |
ステータスコード | 200 |
レスポンスペイロード | { "IsSuccess": true, "ErrorText": "", "ServiceRequests": [ { "bNew": true, "strSubscriptionRecId": "0C1780F4EC814CB2B8E045325D8CFB66", "strRequestRecId": "6730C50F527A481A81FFE15D7D60725F", "strIssueRecId": null、 "strRequestNum": "10288", "strName": "最小SR", "strStatus": null, "strStatusId": null, "strService": null, "strServiceId": null, "strDetails": null、 "パラメータテンプレートパラメータID": {}, "DateApproved": null, "DateCancelled": null, "DateCompleted": null } ], 「無効なサービスリクエスト」: {} } |
フィールド値
Create Service Request API の実行に使用されるフィールドの値を取得する方法については、以下に詳しく説明します。
strCustomerLocation と strUserIdの値を取得するには、API を実行します - https://{tenant URL}/api/odata/businessobject/Frs_CompositeContract_Contacts?$filter=NetworkUserName eq '{your user name}'
取得した応答から、 Employee Location の値は strCustomerLocation の値になり、 RecID の値は strUserId の値になります。
subscriptionIdの値を取得するには、API - https://{tenant URL}/api/rest/Template//<User_RecId>All を実行します。
これにより、サービス カタログに公開されているすべてのテンプレートが提供されます。 取得した応答から、 strSubscriptionId の値が subscriptionId の値になります。
localoffset の値は、特定の場所の協定世界時からの分単位の差です。 たとえば、現在地がインドの場合、GMT/UTC は 5.30 時間、つまり 330 分なので、現在地の localoffset 値は -330になります。
フィールドの RecID を取得するには、API - https://{tenant url}/api/rest/ServiceRequest/PackageData/subscriptionId/strCustomerLocationを実行します。
応答から、 lstParamCategories/lstParameters を探して展開します。 すべてのフィールドには RecIDがあります。フィールドを展開すると、その RecIDが表示されます。
フィールド RecID

パラメータ
パラメータの基本構造は次のとおりです。
「パラメータ」: {
// {パラメータ名}
"par-{Parameter RecID}": "value",
}
「パラメータ」: {
// チェックボックス
"par-{Parameter RecID}": "true",
// テキストフィールド
"par-{Parameter RecID}": "Text Field",
// テキストエリア
"par-{Parameter RecID}": "Text Area",
// 落ちる
"par-{Parameter RecID}": "Scheduled",
"par-{Parameter RecID}-recId": "{Field RecID of Scheduled}",
// 時間フィールド
"par-{Parameter RecID}": "{system generated time}",
// 日時フィールド
"par-{Parameter RecID}": "{system generated time}",
// 選択リスト
"par-{Parameter RecID}": "Active",
"par-{Parameter RecID}-recId": "{Field RecID of Active}"
}
パラメータ付きのサンプル サービス申請

ドロップダウン リスト/選択リストと添付ファイルは、他のパラメータとは異なる動作をします。 詳細については、「ドロップダウンと選択リストと添付ファイル」を参照してください。
ドロップダウンとピックリストの場合は、値の RecID が必要になります。それを取得するには、次の API を実行します。
GET: /api/rest/ServiceRequest//ValidationList
ブラウザの代わりに Postman または同様のアプリを使用し、 Content-Type を application/jsonに設定します。
例:
- 実行 - GET: /api/rest/ServiceRequest/ 6B5A00312E00430AAF8769D1A27326C6/ValidationList
応答にはすべての値の Rec ID が含まれます。 たとえば、値 Alex の RecID は「026221D7927F4104810ABF14672FCC3」です。
- 以下のようにパラメータ XYZ に使用します。
「パラメータ」: {
"par-A72D69AF2A9B420F874BA8A5A293EF17": "Alex",
"par-A72D69AF2A9B420F874BA8A5A293EF17-recId": "026221D7927F4104810ABF14672FCC3"
}
サービス申請に添付ファイルをアップロードするには、添付ファイルのトークンが必要になります。
トークンを取得するには、次の API を実行します。
- POST: api/rest/Attachment/newSR
ブラウザの代わりに Postman または同様のアプリを使用し、リクエスト本文を Form-dataとして設定します。
- 応答からトークンをコピーします。
トークンを含むサンプルレスポンス

サービス申請でトークンを使用する:
アップロードする添付ファイル: [["{トークンID}", "
失敗した応答
シナリオ: リクエスト本文が空の サービス申請を作成しようとしています。
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 無効なリクエストペイロード |
メッセージ | { 「メッセージ本文は空にできません。」 } |
HTTP ステータス コード | 400 |
シナリオ: 無効なリクエスト本文で サービス申請を作成しようとしています。
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 無効なリクエストペイロード |
メッセージ | [ 「ビジネス オブジェクトが無効です。」 ], |
HTTP ステータス コード | 400 |
シナリオ: 必須フィールドが欠落している サービス申請を作成しようとしています。
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 無効なリクエストペイロード |
メッセージ | [ 「必須フィールドパラメータがありません」 ] |
HTTP ステータス コード | 400 |
シナリオ: サービス申請を作成しようとしたときにアプリケーションが保存に失敗した場合。
ヘッダー名:
認証: セッションキー
コード | ISM_5000 |
|---|---|
説明 | 内部サーバーエラー |
メッセージ | [ 「サーバーに内部エラーが発生しました。 リクエストを再試行してください。" ], |
HTTP ステータス コード | 500 |
