Create a business category
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this business category applies. -
BusCategory(required): string
Maximum Length:
50
The unique identifier for the business category. -
BusinessSubcategory: array
Business Subcategories
Title:
Business Subcategories
Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity. -
Category(required): string
Maximum Length:
25
The value that will be displayed for business category. -
Description(required): string
Maximum Length:
100
The long description value for business category. -
EnabledFlag(required): string
Maximum Length:
1
Indicates whether the business category is enabled. The default value is Yes.
Nested Schema : Business Subcategories
Type:
array
Title:
Business Subcategories
Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.
Show Source
Nested Schema : publicSectorBusinessCategories-BusinessSubcategory-item-post-request
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this business subcategory applies. -
BusCategory: string
Maximum Length:
50
The unique identifier for the business category. -
BusSubCategory: string
Maximum Length:
50
The unique identifier for the business subcategory. -
Description: string
Maximum Length:
100
The long description value for business subcategory. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the business subcategory is enabled. The default value is Yes. -
Subcategory: string
Maximum Length:
25
The value that will be displayed for business subcategory.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBusinessCategories-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this business category applies. -
BusCategory: string
Maximum Length:
50
The unique identifier for the business category. -
BusinessSubcategory: array
Business Subcategories
Title:
Business Subcategories
Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity. -
Category: string
Maximum Length:
25
The value that will be displayed for business category. -
Description: string
Maximum Length:
100
The long description value for business category. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the business category is enabled. The default value is Yes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Business Subcategories
Type:
array
Title:
Business Subcategories
Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessCategories-BusinessSubcategory-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this business subcategory applies. -
BusCategory: string
Maximum Length:
50
The unique identifier for the business category. -
BusSubCategory: string
Maximum Length:
50
The unique identifier for the business subcategory. -
Description: string
Maximum Length:
100
The long description value for business subcategory. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the business subcategory is enabled. The default value is Yes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Subcategory: string
Maximum Length:
25
The value that will be displayed for business subcategory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BusinessSubcategory
-
Parameters:
- publicSectorBusinessCategoriesUniqID:
$request.path.publicSectorBusinessCategoriesUniqID
Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity. - publicSectorBusinessCategoriesUniqID: