This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Product

1: APIs

1.1: List Product Categories

1.1.1: 1.0

1.2: List Products

1.2.1: 1.0

1.3: Show Product

1.3.1: 1.0

1.4: Show Product category

1.4.1: 1.0

2: Models

2.1: ProductCategoryListResponse
2.2: ProductCategoryResponse
2.3: ProductListResponse
2.4: ProductResponse

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of PRODUCT service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://product.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - List Product Categories

1.1.1 - 1.0

get /v1/product-categories

Description

List product categories

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	LIMIT Example : `10`	integer	None
query	page optional	Page Example : `1`	integer	None
query	display_name optional	Product Category Name Example : `Networking`	array[any of [string, null]]	[]
query	display_name_ko optional	Product Category Name Example : `Networking`	array[any of [string, null]]	[]
query	is_exposed_menu optional	Product Category Menu Exposed Status Example : `True`	array[any of [boolean, null]]	[]
query	created_by optional	Created by Example : `김삼성`	any of [string, null]	None
query	modified_by optional	Modified by Example : `김삼성`	any of [string, null]	None
query	created_start_date optional	Created start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	created_end_date optional	Created end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_start_date optional	Modified start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_end_date optional	Modified end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	sort optional	Sort Example : `created_at:asc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ProductCategoryListResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/product-categories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = product 1.0"

Example HTTP response

Response 200

{
    "count": 5,
    "current_page": "",
    "product_categories": [
        {
            "category_id": "NETWORKING",
            "created_at": "2024-01-01T00:00:00",
            "created_by": "5cada9f6afa049418c4f18c0c4859202",
            "display_name": "Networking",
            "display_name_ko": "Networking",
            "icon_file_id": "c1d5c1f63bf24f73b32c37f6f7b50310",
            "is_exposed_menu": "True",
            "modified_at": "2024-01-01T00:00:00",
            "modified_by": "5cada9f6afa049418c4f18c0c4859202",
            "seq": 9,
            "service_group_color_id": "ffff00"
        }
    ],
    "total_count": 5,
    "total_pages": ""
}

1.2 - List Products

1.2.1 - 1.0

get /v1/products

Description

List products.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	LIMIT Example : `10`	integer	None
query	page optional	Page Example : `1`	integer	None
query	product_category_id optional	Product Category ID Example : `NETWORKING`	array[any of [string, null]]	[]
query	product_id optional	Product ID Example : `VPC`	array[any of [string, null]]	[]
query	display_name optional	Product name Example : `VPC`	array[any of [string, null]]	[]
query	display_name_ko optional	Product name Example : `VPC`	array[any of [string, null]]	[]
query	kind optional	Product Kind Example : `PRODUCT`	array[any of [string, null]]	[]
query	created_start_date optional	Created start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	created_end_date optional	Created end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_start_date optional	Modified start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_end_date optional	Modified end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	sort optional	Sort Example : `created_at:asc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ProductListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/products

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = product 1.0"

Example HTTP response

Response 200

{
    "count": 5,
    "current_page": 1,
    "products": [
        {
            "created_at": "2024-01-01T00:00:00",
            "created_by": "5cada9f6afa049418c4f18c0c4859202",
            "display_name": "VPC",
            "display_name_ko": "VPC",
            "kind": "PRODUCT",
            "modified_at": "2024-01-01T00:00:00",
            "modified_by": "5cada9f6afa049418c4f18c0c4859202",
            "product_category_id": "NETWORKING",
            "product_category_name": "Networking",
            "product_id": "VPC"
        }
    ],
    "total_count": 5,
    "total_pages": 1
}

1.3 - Show Product

1.3.1 - 1.0

get /v1/products/{product_id}

Description

Show product.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	product_id required	Product ID Example : `VPC`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ProductResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/products/{product_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = product 1.0"

Example HTTP response

Response 200

{
    "created_at": "2024-01-01T00:00:00",
    "created_by": "5cada9f6afa049418c4f18c0c4859202",
    "display_name": "VPC",
    "display_name_ko": "VPC",
    "kind": "PRODUCT",
    "modified_at": "2024-01-01T00:00:00",
    "modified_by": "5cada9f6afa049418c4f18c0c4859202",
    "product_category_id": "NETWORKING",
    "product_category_name": "Networking",
    "product_id": "VPC"
}

1.4 - Show Product category

1.4.1 - 1.0

get /v1/product-categories/{category_id}

Description

Show product category.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	category_id required	Product Category ID Example : `NETWORKING`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ProductCategoryResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/product-categories/{category_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = product 1.0"

Example HTTP response

Response 200

{
    "category_id": "NETWORKING",
    "created_at": "2024-01-01T00:00:00",
    "created_by": "5cada9f6afa049418c4f18c0c4859202",
    "display_name": "Networking",
    "display_name_ko": "Networking",
    "icon_file_id": "c1d5c1f63bf24f73b32c37f6f7b50310",
    "is_exposed_menu": "True",
    "modified_at": "2024-01-01T00:00:00",
    "modified_by": "5cada9f6afa049418c4f18c0c4859202",
    "seq": 9,
    "service_group_color_id": "ffff00"
}

2 - Models

2.1 - ProductCategoryListResponse

Name	Description	Schema
count optional	Count Example : `5`	any of [integer, null]
current_page optional	Example :	any of [integer, null]
product_categories optional	Product Categories	array[ProductCategoryResponse]
total_count optional	Example : `5`	any of [integer, null]
total_pages optional	Example :	any of [integer, null]

2.2 - ProductCategoryResponse

Name	Description	Schema
category_id optional	Product Category ID Example : `NETWORKING`	any of [string, null]
created_at optional	Created date Example : `2024-01-01T00:00:00`	string (date-time)
created_by optional	Created by Example : `5cada9f6afa049418c4f18c0c4859202`	string
display_name optional	Product Category Name Example : `Networking` Pattern : `[a-zA-Z0-9_\-()\s]{2,30}$`	any of [string, null]
display_name_ko optional	Product Category Name Example : `Networking` Pattern : `^[가-힣a-zA-Z0-9_\-()\s]{2,30}$`	any of [string, null]
icon_file_id optional	Icon File ID Example : `c1d5c1f63bf24f73b32c37f6f7b50310`	any of [string, null]
is_exposed_menu optional	Product Category Menu Exposed Status Example : `True`	any of [boolean, null]
modified_at optional	Modified date Example : `2024-01-01T00:00:00`	string (date-time)
modified_by optional	Modified by Example : `5cada9f6afa049418c4f18c0c4859202`	string
seq optional	Seq Example : `9`	any of [integer, null]
service_group_color_id optional	Service Group Color Example : `ffff00`	any of [string, null]

2.3 - ProductListResponse

Name	Description	Schema
count optional	Count Example : `5`	any of [integer, null]
current_page optional	Current page Example : `1`	any of [integer, null]
products optional	Products	array[ProductResponse]
total_count optional	Total count Example : `5`	any of [integer, null]
total_pages optional	Total pages Example : `1`	any of [integer, null]

2.4 - ProductResponse

Name	Description	Schema
created_at required	Created date Example : `2024-01-01T00:00:00`	string (date-time)
created_by required	Created by Example : `5cada9f6afa049418c4f18c0c4859202`	string
display_name optional	Product name Example : `VPC`	any of [string, null]
display_name_ko optional	Product name Example : `VPC`	any of [string, null]
kind optional	Product Kind Example : `PRODUCT`	string
modified_at required	Modified date Example : `2024-01-01T00:00:00`	string (date-time)
modified_by required	Modified by Example : `5cada9f6afa049418c4f18c0c4859202`	string
product_category_id optional	Product Category ID Example : `NETWORKING`	any of [string, null]
product_category_name optional	Product Category Name Example : `Networking`	any of [string, null]
product_id optional	Product ID Example : `VPC`	any of [string, null]