Update a status history event record
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
StatusHistoryKey: integer
The unique identifier of status history.
The following table describes the body parameters in the request 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. -
CreatedByName(optional):
string
The user who changed the status.
-
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. -
OriginalCreatedBy(optional):
string
Indicates the user who created the migrated data from source system.
-
Reason(optional):
string
Title:
Reason
Maximum Length:1000
The reason for the status change. -
RecordNumber(optional):
string
Maximum Length:
64
Indicates the parent public unique identifier of status history used for import activity. -
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. -
StatusHistoryKey(optional):
integer(int64)
The unique identifier of status history.
-
StatusHistoryPuid(optional):
string
Maximum Length:
480
Indicates the public unique identifier of the status history used for import activity. -
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.
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. -
CreatedByName(optional):
string
The user who changed the status.
-
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. -
OriginalCreatedBy(optional):
string
Indicates the user who created the migrated data from source system.
-
Reason(optional):
string
Title:
Reason
Maximum Length:1000
The reason for the status change. -
RecordNumber(optional):
string
Maximum Length:
64
Indicates the parent public unique identifier of status history used for import activity. -
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. -
StatusHistoryKey(optional):
integer(int64)
The unique identifier of status history.
-
StatusHistoryPuid(optional):
string
Maximum Length:
480
Indicates the public unique identifier of the status history used for import activity. -
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.