Get a record status
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Request
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.