Update a code enforcement status
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorCodeEnforcementStatusesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, Classification and Status ---for the Code Enforcement Statuses resource and used to uniquely identify an instance of Code Enforcement Statuses. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Statuses.
For example: publicSectorCodeEnforcementStatuses?q=AgencyId=<value1>;Classification=<value2>;Status=<value3>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCodeEnforcementStatuses-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency.
-
Classification(optional):
string
Maximum Length:
15
The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the code enforcement status. -
CreationDate(optional):
string(date-time)
The date and time that the code enforcement status was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is deleted. -
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the record is enabled. -
LastUpdateDate(optional):
string(date-time)
The date and time that the code enforcement status was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the code enforcement status. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the code enforcement status. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
SeedDataLock(optional):
integer(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
-
Status(optional):
string
Title:
Status
Maximum Length:15
The unique identifier of the code enforcement status code. -
StatusName(optional):
string
Title:
Description
Maximum Length:30
The description of the code enforcement status code. -
SystemUse(optional):
string
Maximum Length:
1
Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.
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 : publicSectorCodeEnforcementStatuses-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency.
-
Classification(optional):
string
Maximum Length:
15
The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the code enforcement status. -
CreationDate(optional):
string(date-time)
The date and time that the code enforcement status was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is deleted. -
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the record is enabled. -
LastUpdateDate(optional):
string(date-time)
The date and time that the code enforcement status was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the code enforcement status. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the code enforcement status. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
SeedDataLock(optional):
integer(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
-
Status(optional):
string
Title:
Status
Maximum Length:15
The unique identifier of the code enforcement status code. -
StatusName(optional):
string
Title:
Description
Maximum Length:30
The description of the code enforcement status code. -
SystemUse(optional):
string
Maximum Length:
1
Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.
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.