Update a record status
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorRecordStatusesUniqID: integer
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRecordStatuses-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier a public sector agency. -
Classification(optional):
string
Maximum Length:
3
The classification for the transaction status. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the related record status. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the related record status was created. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description for the record status. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the record status is available to be used or not. The default value is false. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the related record status was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the related record status. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordStatus(optional):
string
Title:
Status
Maximum Length:15
The unique identifier of the status of the record. -
SeedDataLock(optional):
integer(int32)
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(optional):
string
Title:
System Status
Maximum Length:15
The predefined system status to which the record status maps. -
SystemUse(optional):
string
Maximum Length:
1
Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecordStatuses-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier a public sector agency. -
Classification(optional):
string
Maximum Length:
3
The classification for the transaction status. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the related record status. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the related record status was created. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description for the record status. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the record status is available to be used or not. The default value is false. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the related record status was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the related record status. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordStatus(optional):
string
Title:
Status
Maximum Length:15
The unique identifier of the status of the record. -
SeedDataLock(optional):
integer(int32)
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(optional):
string
Title:
System Status
Maximum Length:15
The predefined system status to which the record status maps. -
SystemUse(optional):
string
Maximum Length:
1
Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.