NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve a contract category
get
/spms/v1/contractCategories/{id}
This is to retrieve a contract category by record id
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Returns a contract category based on the id
Root Schema : ContractCategoryWithId
Type:
objectContract Category
Show Source
-
description:
string
Minimum Value:
2Maximum Value:200Pattern:^[a-zA-Z0-9 ]*$Example:Contract Category description -
id(optional):
integer
Minimum Value:
1This is the Contract Category primary keyExample:1 -
name:
string
Minimum Value:
2Maximum Value:100Pattern:^[a-zA-Z0-9 ]*$Example:Contract Category name
400 Response
The supplied parameter(s) is not valid
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
The Contract Category does not exist
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
The media supplied is not supported
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occurred while processing this request
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available