Update a record status
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Request
Path Parameters
-
publicSectorRecordStatusesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, Classification and RecordStatus ---for the Record Statuses resource and used to uniquely identify an instance of Record Statuses. The client should not generate the hash key value. Instead, the client should query on the Record Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Statuses.
For example: publicSectorRecordStatuses?q=AgencyId=<value1>;Classification=<value2>;RecordStatus=<value3>
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
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier a public sector agency. -
Classification: string
Maximum Length:
3
The classification for the transaction status. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record. -
Description: string
Title:
Description
Maximum Length:100
The description for the record status. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the record status is available to be used or not. The default value is false. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether the row is delivered seed data or customer data. Valid values are 0 for customer data, 1 for delivered seed data that cannot be modified, and 2 for delivered seed data that can be modified. -
SystemStatus: string
Title:
System Status
Maximum Length:15
The predefined system status to which the record status maps. -
SystemUse: string
Title:
System Use
Maximum Length:1
Default Value:N
Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
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 : publicSectorRecordStatuses-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier a public sector agency. -
Classification: string
Maximum Length:
3
The classification for the transaction status. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the related record status was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record. -
Description: string
Title:
Description
Maximum Length:100
The description for the record status. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the record status is available to be used or not. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the related record status was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordStatus: string
Title:
Status
Maximum Length:15
The unique identifier of the status of the record. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether the row is delivered seed data or customer data. Valid values are 0 for customer data, 1 for delivered seed data that cannot be modified, and 2 for delivered seed data that can be modified. -
SystemStatus: string
Title:
System Status
Maximum Length:15
The predefined system status to which the record status maps. -
SystemUse: string
Title:
System Use
Maximum Length:1
Default Value:N
Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
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.