Update a comment application group option
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroupOptions/{publicSectorCommentApplicationGroupOptionsUniqID}
Request
Path Parameters
-
publicSectorCommentApplicationGroupOptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and ApplicationGroupCode ---for the Comment Application Group Options resource and used to uniquely identify an instance of Comment Application Group Options. The client should not generate the hash key value. Instead, the client should query on the Comment Application Group Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Comment Application Group Options.
For example: publicSectorCommentApplicationGroupOptions?q=AgencyId=<value1>;ApplicationGroupCode=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DefaultVisibilityFlag: string
Title:
Private
Maximum Length:1
Default Value:N
The identifier for the default visibility of comments. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
The identifier for the deleted row. -
ModuleId: string
Maximum Length:
32
The identifier of the record module. -
ObjectVersionNumber: integer
(int32)
The version number of the record.
-
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated. -
SeedDataSource: string
Maximum Length:
512
Indicates the data source for the seed data.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorCommentApplicationGroupOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency ID of the record. -
ApplicationGroupCode: string
Title:
Comment Application Group
Maximum Length:30
The identifier of the application group in the record. -
ApplicationGroupName: string
Read Only:
true
Maximum Length:255
The name of the application group in the record. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
DefaultVisibilityFlag: string
Title:
Private
Maximum Length:1
Default Value:N
The identifier for the default visibility of comments. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
The identifier for the deleted row. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The name of the logged in user when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The identifier of the record module. -
ObjectVersionNumber: integer
(int32)
The version number of the record.
-
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated. -
SeedDataSource: string
Maximum Length:
512
Indicates the data source for the seed data.
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.