Jump to

• Request
• Response

Create a record status

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier a public sector agency.
• Classification: string
  Maximum Length: 3

  The classification for the transaction status.
• DeletedFlag: string
  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.
• Description: string
  Title: Description

  Maximum Length: 100

  The description for the record status.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the record status is available to be used or not. The default value is false.
• RecordStatus: string
  Title: Status

  Maximum Length: 15

  The unique identifier of the status of the record.
• SeedDataLock: integer (int32)
  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.
• SystemStatus: string
  Title: System Status

  Maximum Length: 15

  The predefined system status to which the record status maps.
• SystemUse: string
  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.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "title":"System Status",
            "maxLength":15,
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description for the record status.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification for the transaction status.",
            "nullable":false
        },
        "SystemUse":{
            "title":"System Use",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.",
            "nullable":true,
            "default":"N"
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "nullable":false,
            "default":"N"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the record status is available to be used or not. The default value is false.",
            "nullable":false
        },
        "RecordStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the status of the record.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorRecordStatuses-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier a public sector agency.
• Classification: string
  Maximum Length: 3

  The classification for the transaction status.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the related record status.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the related record status was created.
• DeletedFlag: string
  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.
• Description: string
  Title: Description

  Maximum Length: 100

  The description for the record status.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the record status is available to be used or not. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the related record status was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the related record status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordStatus: string
  Title: Status

  Maximum Length: 15

  The unique identifier of the status of the record.
• SeedDataLock: integer (int32)
  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.
• SystemStatus: string
  Title: System Status

  Maximum Length: 15

  The predefined system status to which the record status maps.
• SystemUse: string
  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the related record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"System Status",
            "maxLength":15,
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the related record status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the related record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description for the record status.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "SystemUse":{
            "title":"System Use",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification for the transaction status.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the record status is available to be used or not. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the related record status was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the status of the record.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top