Documentation Powered by ReDoc

Order API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本APIでは、docomo business RINKのオーダーリソース情報の参照・操作が可能です。

orders

申込履歴に関する API カテゴリ

申込履歴 一覧 API

申込履歴 一覧 API

query Parameters
orderStatus
string
Enum: "applied" "processing" "completed" "canceled" "aborted" "rejected"
Example: orderStatus=processing

order のステータスでフィルタ。

  • rejected は明示しない限り hit せず、無指定の場合は他のカテゴリー値のオーダーのみ返却
  • キーバリューペアを繰り返し指定することで最大N個まで Routings リソースを指定可能 (例: statusCategory=processing&statusCategory=completed)
  • 候補値
    • applied: 未処理のオーダー
    • processing: 未処理〜処理中のオーダー
    • completed: 正常終了
    • canceled: ユーザーからのキャンセルで、対象オーダーがこれ以上変化しない状態
    • aborted: システムからの強制キャンセルで、対象オーダーがこれ以上変化しない状態
    • rejected: リクエスト送信段階で内容の不整合などでエラーとなったもの。これ以上変化しない状態
limit
integer [ 1 .. 100 ]
Default: 10

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 10

表示するページ番号の指定 (デフォルト0)

resourceId
string

リソースのIDを指定。完全一致。複数指定不可

requestType
string
Enum: "create" "update" "delete"

リクエストの種別を指定。複数選択可

sortKey
string

ソートに使用する要素を指定

direction
string
Enum: "asc" "desc"

ソート順を指定。asc: 昇順、desc: 降順

resourceType
string
Enum: "fic-connection" "vpn" "terminal" "ipoe" "contractor-setting" "mobile-setting" "phone-ticketing-support" "guarantee" "registration-address" "break-out-list"

リソースタイプを指定。完全一致。複数指定可。

bulkOrderId
string ^[0-9a-f]{32}$
Example: bulkOrderId=62ec2b62646740b5809f695dea7b2bbf

一括オーダーIDを指定。完全一致。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/orders
https://api.ntt.com/sdpf-ztgict/v1/orders

Response samples

Content type
application/json
Example
申込履歴一覧取得(光コラボ申込)
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "orders":
    [
    ]
}

申込履歴 参照 API

申込履歴 参照 API

path Parameters
orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. オーダーステータスと同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/orders/{orderId}
https://api.ntt.com/sdpf-ztgict/v1/orders/{orderId}

Response samples

Content type
application/json
Example
申込履歴の参照(光コラボ申込)
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceId": "Z123456789",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "bulkOrderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ref": "/v1/orders/62ec2b62646740b5809f695dea7b2bbf",
  • "resourceType": "ipoe",
  • "requestType": "create",
  • "orderStatus": "applied",
  • "downloadableDocumentId":
    {
    },
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "request": { },
  • "response":
    {
    }
}

申込内容 変更 API

申込内容 変更 API

  • requestキーに送信したオーダの内容がそのまま入っているので変更箇所を修正してPUTのAPIをコールすることでオーダの変更を行う
  • ギャランティのIWAN工事に関するオーダのみで利用可能
path Parameters
orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. オーダーステータスと同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
  • 申込内容に対する変更内容. 変更点のみ記載
  • fieldSurvey、construction、removalのdate、timeのみ変更可
  • オーダ情報を変更するとSDPの内部処理によってギャランティのリソースに反映される
request
required
object

申込内容に対する変更内容. 変更点のみを記載

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/orders/{orderId}
https://api.ntt.com/sdpf-ztgict/v1/orders/{orderId}

Request samples

Content type
application/json
Example
申込オーダ修正
Copy
 Expand all Collapse all
{
  • "request":
    {
    }
}

Response samples

Content type
application/json
No sample

申込内容 取り消し API

申込内容 取り消し API

注意点:

  • リソースの状態によってはこのオペレーションが実行不可能な場合があります（既に元の申込内容で処理中である場合、対象申込が処理済みである場合など）
path Parameters
orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. オーダーステータスと同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/orders/{orderId}
https://api.ntt.com/sdpf-ztgict/v1/orders/{orderId}

Response samples

Content type
application/json
No sample