Update a status history event record
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
Request
Path Parameters
-
StatusHistoryKey(required): integer(int64)
The unique identifier of status history.
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
-
AttributeChanged: string
Title:
Attribute Changed
Maximum Length:30
The column name or attribute that was changed. -
EventCode: string
Maximum Length:
30
An identifier to track the system events that may not result in a status change. -
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. -
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.
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 : 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.