SDPF Menu API (1.0.0)

Download OpenAPI specification:Download

API Reference for SDPF Menu

Revision History

Date	Version	Detail
2024/08/07	1.0.0	Initial Release

Menu List

The following menus are supported in the {menu} path parameter.

Menu	Path Parameter {menu}
HULFT	hulft
Power Systems	power-systems
Hybrid Cloud with GCP	hc-gcp
Hybrid Cloud with AWS	aws

Authentication

SDPF

SDPF Menu

Show Menu

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/{menu}/{tenant_id}/menu

https://api.ntt.com/sdpf-soy/v1/{menu}/{tenant_id}/menu

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"menu": 
{"name": "menu-name",
"display_name_en": "Display Name",
"display_name_ja": "表示名",
"supports_change_order": true,
"has_file": true,
"is_billing_end_date_set_automatically": true,
"regions": 
["gl1"
]
}
}

List Menu Files

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/{menu}/{tenant_id}/files

https://api.ntt.com/sdpf-soy/v1/{menu}/{tenant_id}/files

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"files": 
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"menu": "menu-name",
"name": "File Name 1",
"language": "en"
},
{"id": "9af29950-b46c-4b45-9fc0-4d21216c3d87",
"menu": "menu-name",
"name": "File Name 1",
"language": "ja"
}
]
}

Show Menu File

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region
file_id required	string <uuid> File ID

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/{menu}/{tenant_id}/files/{file_id}

https://api.ntt.com/sdpf-soy/v1/{menu}/{tenant_id}/files/{file_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"file": 
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"menu": "menu-name",
"name": "File Name",
"content": "U21hcnQgRGF0YSBQbGF0Zm9ybQ==",
"language": "en"
}
}

List Licenses

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region

query Parameters

page	integer >= 1 Default: 1 Page number of the results to fetch
per_page	integer [ 1 .. 100 ] Default: 30 Results per page
status	Array of strings Items Enum: "Under Review" "Send Back" "Active" "Change Order Send Back" "Delete Order Under Review" "Delete Order Send Back" "Deleted" "Change Order Under Review" "Order Completed" Status of the license, and multiple statuses can be specified by separating them with commas
plan_type	string Enum: "Monthly Fixed" "One-Shot" "Monthly Pay-As-You-Go" Plan Type

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/{menu}/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v1/{menu}/{tenant_id}/licenses

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"page": 1,
"per_page": 30,
"total_count": 2,
"licenses": 
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"menu": "menu-name-1",
"name": "メニュー名 1",
"email_address": "user@example.com",
"tenant_id": "cab37c0a5c40450d9038463783b7d53e",
"workspace_id": "ws0000588582",
"region": "gl1",
"status": "Active",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_type": "Monthly Fixed",
"plan_name_en": "Plan Name 1",
"plan_name_ja": "プラン名 1",
"plan_quantity": 1,
"plan_quantity_before_change": null,
"is_plan_quantity_changed": null,
"is_file_updated": null,
"offer_start_request_date": "2023-04-10",
"offer_start_date": "2023-04-10",
"offer_change_request_date": null,
"offer_change_date": null,
"offer_end_request_date": null,
"offer_end_date": null,
"billing_start_date": "2023-04-10",
"billing_change_date": null,
"billing_end_date": null,
"created_at": "2023-04-01T14:15:22Z",
"updated_at": "2023-04-09T14:15:22Z",
"tags": 
[
{"id": "ab260bac-e041-4b26-8d09-a7f1616b75f2",
"name": "Tag Name",
"values": 
["Tag Value 1",
"Tag Value 2"
],
"created_at": "2023-04-01T14:15:22Z",
"updated_at": "2023-04-09T14:15:22Z"
}
]
},
{"id": "8da01882-b131-4b18-8209-00cd25a35d07",
"menu": "menu-name-2",
"name": "License Name 2",
"email_address": "user@example.com",
"tenant_id": "cab37c0a5c40450d9038463783b7d53e",
"workspace_id": "ws0000588582",
"region": "gl1",
"status": "Order Completed",
"plan_id": "f64c8564-cfd5-4544-a091-30d0e5aaa2ae",
"plan_type": "One-Shot",
"plan_name_en": "Plan Name 2",
"plan_name_ja": "プラン名 2",
"plan_quantity": 1,
"plan_quantity_before_change": null,
"is_plan_quantity_changed": null,
"is_file_updated": null,
"offer_start_request_date": "2023-04-10",
"offer_start_date": "2023-04-10",
"offer_change_request_date": null,
"offer_change_date": null,
"offer_end_request_date": null,
"offer_end_date": "2023-04-30",
"billing_start_date": "2023-04-10",
"billing_change_date": null,
"billing_end_date": "2023-04-30",
"created_at": "2023-04-01T14:15:22Z",
"updated_at": "2023-04-09T14:15:22Z",
"tags": 
[
{"id": "2e377d8d-9f04-4957-8b35-5c0d40495cd4",
"name": "Tag Name",
"values": 
["Tag Value 1",
"Tag Value 2"
],
"created_at": "2023-04-01T14:15:22Z",
"updated_at": "2023-04-09T14:15:22Z"
}
]
}
]
}

Create License

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Request Body schema: application/json

license

required

object

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/{menu}/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v1/{menu}/{tenant_id}/licenses

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"license": 
{"name": "License Name",
"email_address": "user@example.com",
"region": "gl1",
"plan_quantity": 1,
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"offer_start_request_date": "2023-04-10",
"file": 
{"name": "File Name",
"content": "U21hcnQgRGF0YSBQbGF0Zm9ybQ=="
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "74ff77cd-42b5-4dd3-9b8d-9c346971fdcf",
"menu": "menu-name",
"name": "Under Review License",
"email_address": "user@example.com",
"tenant_id": "cab37c0a5c40450d9038463783b7d53e",
"workspace_id": "ws0000588582",
"region": "gl1",
"status": "Under Review",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_type": "Monthly Fixed",
"plan_name_en": "Plan Name",
"plan_name_ja": "プラン名",
"plan_quantity": 1,
"plan_quantity_before_change": null,
"is_plan_quantity_changed": null,
"is_file_updated": null,
"offer_start_request_date": "2023-04-10",
"offer_start_date": null,
"offer_change_request_date": null,
"offer_change_date": null,
"offer_end_request_date": null,
"offer_end_date": null,
"billing_start_date": null,
"billing_change_date": null,
"billing_end_date": null,
"created_at": "2023-04-01T14:15:22Z",
"updated_at": "2023-04-01T14:15:22Z",
"tags": [ ]
}
}

Show License

path Parameters

menu required	string Menu Name
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID in gl1 region
license_id required	string <uuid> License ID

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized