Create a comment category
post
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories
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
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CategoryCd(required): string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
CommentApplicationGroups: array
Comment Application Groups
Title:
Comment Application Groups
The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category. -
CommentSubCategories: array
Comment Subcategories
Title:
Comment Subcategories
The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category. -
Description(required): string
Title:
Description
Maximum Length:300
The name of the comment category. -
EnabledFlag(required): boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment category is available to be used. The comment category is disabled by default.
Nested Schema : Comment Application Groups
Type:
array
Title:
Comment Application Groups
The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.
Show Source
Nested Schema : Comment Subcategories
Type:
array
Title:
Comment Subcategories
The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
ApplgroupCd: string
Title:
Application Group
Maximum Length:30
The application group ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled.
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
Description: string
Title:
Description
Maximum Length:300
The name of the comment subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled. -
SubcategoryCd: string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
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 : publicSectorCommentCategories-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
CommentApplicationGroups: array
Comment Application Groups
Title:
Comment Application Groups
The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category. -
CommentSubCategories: array
Comment Subcategories
Title:
Comment Subcategories
The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:300
The name of the comment category. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment category is available to be used. The comment category is disabled by default. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Comment Application Groups
Type:
array
Title:
Comment Application Groups
The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.
Show Source
Nested Schema : Comment Subcategories
Type:
array
Title:
Comment Subcategories
The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCommentCategories-CommentApplicationGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
ApplgroupCd: string
Title:
Application Group
Maximum Length:30
The application group ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : publicSectorCommentCategories-CommentSubCategories-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:300
The name of the comment subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubcategoryCd: string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CommentApplicationGroups
-
Parameters:
- publicSectorCommentCategoriesUniqID:
$request.path.publicSectorCommentCategoriesUniqID
The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category. - publicSectorCommentCategoriesUniqID:
- CommentSubCategories
-
Parameters:
- publicSectorCommentCategoriesUniqID:
$request.path.publicSectorCommentCategoriesUniqID
The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category. - publicSectorCommentCategoriesUniqID: