Create a code enforcement status
post
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an agency.
-
Classification: string
Maximum Length:
15
The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the record is deleted. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the record is enabled. -
ObjectVersionNumber: 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: integer
(int32)
Default Value:
0
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: string
Title:
Status
Maximum Length:15
The unique identifier of the code enforcement status code. -
StatusName: string
Title:
Description
Maximum Length:30
The description of the code enforcement status code. -
SystemStatus: string
Title:
System Status
Maximum Length:15
The delivered value of a code enforcement status. -
SystemUse: 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.
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 : publicSectorCodeEnforcementStatuses-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an agency.
-
Classification: 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: string
Read Only:
true
Maximum Length:64
The user who created the code enforcement status. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the code enforcement status was created. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the record is deleted. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the record is enabled. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the code enforcement status was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the code enforcement status. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the code enforcement status. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: 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: integer
(int32)
Default Value:
0
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: string
Title:
Status
Maximum Length:15
The unique identifier of the code enforcement status code. -
StatusName: string
Title:
Description
Maximum Length:30
The description of the code enforcement status code. -
SystemStatus: string
Title:
System Status
Maximum Length:15
The delivered value of a code enforcement status. -
SystemUse: 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 : 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.