Create a record status

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The unique identifier a public sector agency.
  • Maximum Length: 3
    The classification for the transaction status.
  • Maximum Length: 1
    Default Value: N
    Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.
  • Title: Description
    Maximum Length: 100
    The description for the record status.
  • Title: Enabled
    Maximum Length: 1
    Indicates whether the record status is available to be used or not. The default value is false.
  • Title: Status
    Maximum Length: 15
    The unique identifier of the status of the record.
  • Default Value: 0
    Indicates whether the row is delivered seed data or customer data. Valid values are 0 for customer data, 1 for delivered seed data that cannot be modified, and 2 for delivered seed data that can be modified.
  • Title: System Status
    Maximum Length: 15
    The predefined system status to which the record status maps.
  • Title: System Use
    Maximum Length: 1
    Default Value: N
    Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorRecordStatuses-item-response
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The unique identifier a public sector agency.
  • Maximum Length: 3
    The classification for the transaction status.
  • Title: Creation Date
    Read Only: true
    The date when the related record status was created.
  • Maximum Length: 1
    Default Value: N
    Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.
  • Title: Description
    Maximum Length: 100
    The description for the record status.
  • Title: Enabled
    Maximum Length: 1
    Indicates whether the record status is available to be used or not. The default value is false.
  • Title: Last Updated Date
    Read Only: true
    The date when the related record status was last updated.
  • Links
  • Title: Status
    Maximum Length: 15
    The unique identifier of the status of the record.
  • Default Value: 0
    Indicates whether the row is delivered seed data or customer data. Valid values are 0 for customer data, 1 for delivered seed data that cannot be modified, and 2 for delivered seed data that can be modified.
  • Title: System Status
    Maximum Length: 15
    The predefined system status to which the record status maps.
  • Title: System Use
    Maximum Length: 1
    Default Value: N
    Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.
Back to Top