Jump to

• Request
• Response

Create a record status

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorRecordStatuses-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

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

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

  Maximum Length: 64

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

  The date when the related record status was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

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

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

  Maximum Length: 64

  The user who last updated the related record status.
• links(optional): array Items
  Title: Items

  Link Relations
• RecordStatus(optional): string
  Title: Status

  Maximum Length: 15

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

  Maximum Length: 15

  The predefined system status to which the record status maps.
• SystemUse(optional): string
  Maximum Length: 1

  Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier a public sector agency.",
            "title":"Agency ID"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification for the transaction status."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the related record status.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record status was created.",
            "title":"Creation Date"
        },
        "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."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the record status.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the record status is available to be used or not. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record status was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the related record status.",
            "title":"Last Updated By"
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the status of the record.",
            "title":"Status"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "title":"System Status"
        },
        "SystemUse":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRecordStatuses-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

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

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

  Maximum Length: 64

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

  The date when the related record status was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record status is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

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

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

  Maximum Length: 64

  The user who last updated the related record status.
• links(optional): array Items
  Title: Items

  Link Relations
• RecordStatus(optional): string
  Title: Status

  Maximum Length: 15

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

  Maximum Length: 15

  The predefined system status to which the record status maps.
• SystemUse(optional): string
  Maximum Length: 1

  Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier a public sector agency.",
            "title":"Agency ID"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification for the transaction status."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the related record status.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record status was created.",
            "title":"Creation Date"
        },
        "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."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the record status.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the record status is available to be used or not. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record status was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the related record status.",
            "title":"Last Updated By"
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the status of the record.",
            "title":"Status"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "title":"System Status"
        },
        "SystemUse":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a status is delivered as system data for system usage. Valid values are Yes and No."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top