Get a status history event record
get
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{publicSectorStatusHistoriesUniqID}
Request
Path Parameters
-
publicSectorStatusHistoriesUniqID: integer
This is the hash key of the attributes which make up the composite key--- TransactionType, TransactionKey and ChangeDate ---for the Status Histories resource and used to uniquely identify an instance of Status Histories. The client should not generate the hash key value. Instead, the client should query on the Status Histories collection resource with a filter on the primary key values in order to navigate to a specific instance of Status Histories.
For example: publicSectorStatusHistories?q=TransactionType=<value1>;TransactionKey=<value2>;ChangeDate=<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 : publicSectorStatusHistories-item
Type:
Show Source
object
-
AttributeChanged(optional):
string
Title:
Attribute Changed
Maximum Length:30
The column name or attribute that was changed. -
ChangeDate(optional):
string(date-time)
Title:
Updated Date
The date when the status change was made. -
CreatedBy(optional):
string
Title:
Updated By
Maximum Length:64
The user who changed the status. -
CreatedByName(optional):
string
The user who changed the status.
-
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the status was changed. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the status change was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who made the last status change. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit
Maximum Length:50
The permit transaction identification number. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the related permit transaction.
-
NewValue(optional):
string
Title:
Status
Maximum Length:100
The new value for the column or attribute that was changed. -
Reason(optional):
string
Title:
Reason
Maximum Length:1000
The reason for the status change. -
RecordTypeCode(optional):
string
Title:
Permit Type Code
Maximum Length:20
The unique identifier for the permit type code. -
RelAttributeChanged(optional):
string
Title:
Related Attribute Changed
Maximum Length:30
The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the permit transaction, for example, the main attribute is Permit Status and a secondary or related attribute is System Status. -
RelNewValue(optional):
string
Title:
Related Value
Maximum Length:100
The new value for the related attribute that was changed. The related attribute value is a secondary attribute value for a given transaction. For the permit transaction, for example, the secondary or related attribute is System Status and the related attribute value could be PND or Pending. -
TransactionId(optional):
string
Title:
Transaction ID
Maximum Length:100
The transaction identification number. -
TransactionKey(optional):
string
Title:
Transaction Key
Maximum Length:100
The unique identifier for the subject code transaction. -
TransactionType(optional):
string
Title:
Transaction Type
Maximum Length:10
The transaction type relating to the status change. For example, plan review, inspection, or hearing.
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.