Get a status history event record
get
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
Request
Path Parameters
-
StatusHistoryKey(required): integer(int64)
The unique identifier of status history.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorStatusHistories-item-response
Type:
Show Source
object
-
AttributeChanged: string
Title:
Attribute Changed
Maximum Length:30
The column name or attribute that was changed. -
ChangeDate: string
(date-time)
Title:
Updated Date
The date when the status change was made. -
CreatedByName: string
Read Only:
true
The user who changed the status. -
EventCode: string
Maximum Length:
30
An identifier to track the system events that may not result in a status change. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Permit
Maximum Length:50
The permit transaction identification number. -
LnpRecordKey: integer
(int64)
The unique identifier for the related permit transaction.
-
NewValue: string
Title:
Status
Maximum Length:100
The new value for the column or attribute that was changed. -
OriginalCreatedBy: string
Indicates the user who created the migrated data from source system.
-
Reason: string
Title:
Reason
Maximum Length:1000
The reason for the status change. -
RecordNumber: string
Maximum Length:
64
Indicates the parent public unique identifier of status history used for import activity. -
RecordTypeCode: string
Title:
Permit Type Code
Maximum Length:20
The unique identifier for the permit type code. -
RelAttributeChanged: 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: 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. -
StatusHistoryKey: integer
(int64)
The unique identifier of status history.
-
StatusHistoryPuid: string
Maximum Length:
480
Indicates the public unique identifier of the status history used for import activity. -
TransactionId: string
Title:
Transaction ID
Maximum Length:100
The transaction identification number. -
TransactionKey: string
Title:
Transaction Key
Maximum Length:100
The unique identifier for the subject code transaction. -
TransactionType: string
Title:
Transaction Type
Maximum Length:10
The transaction type relating to the status change. For example, plan review, inspection, or hearing.
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.