Jump to

• Request
• Response

Create a checklist item

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems

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 : publicSectorInspectionChecklistItems-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with this inspection checklist item.
• CategoryCode(optional): string
  Maximum Length: 30

  The category of the inspection checklist item.
• ChecklistId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the checklist item.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the checklist item was created.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The description of the inspection checklist item.
• Instruction(optional): array Inspection Checklist Instructions
  Title: Inspection Checklist Instructions

  The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist item was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the checklist item.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. The default value is true.
• Score(optional): integer(int32)
  Title: Score

  The score that the checklist item received.
• SubcategoryCode(optional): string
  Maximum Length: 30

  The subcategory of the inspection checklist item.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with this inspection checklist item.",
            "type":"integer",
            "format":"int64"
        },
        "CategoryCode":{
            "description":"The category of the inspection checklist item.",
            "type":"string",
            "maxLength":30
        },
        "ChecklistId":{
            "description":"The unique identifier for an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "ChecklistItemId":{
            "description":"The unique identifier for an inspection checklist item.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the checklist item.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the checklist item was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the inspection checklist item.",
            "type":"string",
            "maxLength":300
        },
        "Instruction":{
            "title":"Inspection Checklist Instructions",
            "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the checklist item was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The session login associated with the user who last updated the checklist item.",
            "type":"string",
            "maxLength":64
        },
        "MajorViolationFlag":{
            "description":"Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.",
            "type":"boolean"
        },
        "RequiredFlag":{
            "title":"Required",
            "description":"Indicates whether this inspection checklist item is required. The default value is true.",
            "type":"boolean"
        },
        "Score":{
            "title":"Score",
            "description":"The score that the checklist item received.",
            "type":"integer",
            "format":"int32"
        },
        "SubcategoryCode":{
            "description":"The subcategory of the inspection checklist item.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Inspection Checklist Instructions

Type: array

Title: Inspection Checklist Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Show Source

• Array of: object publicSectorInspectionChecklistItems-Instruction-item

{
    "title":"Inspection Checklist Instructions",
    "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorInspectionChecklistItems-Instruction-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with these checklist item instructions.
• ChecklistId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the instructions were created.
• InstructionCode(optional): string
  Maximum Length: 15

  The code for the instructions that are associated with an item in an inspection checklist.
• InstructionText(optional): string
  Maximum Length: 1000

  The text that includes the instructions for an inspection checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the instructions were last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the instructions.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with these checklist item instructions.",
            "type":"integer",
            "format":"int64"
        },
        "ChecklistId":{
            "description":"The unique identifier for an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "ChecklistItemId":{
            "description":"The unique identifier for an inspection checklist item.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the instructions.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the instructions were created.",
            "type":"string",
            "format":"date-time"
        },
        "InstructionCode":{
            "description":"The code for the instructions that are associated with an item in an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "InstructionText":{
            "description":"The text that includes the instructions for an inspection checklist item.",
            "type":"string",
            "maxLength":1000
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the instructions were last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The session login associated with the user who last updated the instructions.",
            "type":"string",
            "maxLength":64
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorInspectionChecklistItems-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with this inspection checklist item.
• CategoryCode(optional): string
  Maximum Length: 30

  The category of the inspection checklist item.
• ChecklistId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the checklist item.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the checklist item was created.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The description of the inspection checklist item.
• Instruction(optional): array Inspection Checklist Instructions
  Title: Inspection Checklist Instructions

  The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist item was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the checklist item.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. The default value is true.
• Score(optional): integer(int32)
  Title: Score

  The score that the checklist item received.
• SubcategoryCode(optional): string
  Maximum Length: 30

  The subcategory of the inspection checklist item.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with this inspection checklist item.",
            "type":"integer",
            "format":"int64"
        },
        "CategoryCode":{
            "description":"The category of the inspection checklist item.",
            "type":"string",
            "maxLength":30
        },
        "ChecklistId":{
            "description":"The unique identifier for an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "ChecklistItemId":{
            "description":"The unique identifier for an inspection checklist item.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the checklist item.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the checklist item was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the inspection checklist item.",
            "type":"string",
            "maxLength":300
        },
        "Instruction":{
            "title":"Inspection Checklist Instructions",
            "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the checklist item was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The session login associated with the user who last updated the checklist item.",
            "type":"string",
            "maxLength":64
        },
        "MajorViolationFlag":{
            "description":"Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.",
            "type":"boolean"
        },
        "RequiredFlag":{
            "title":"Required",
            "description":"Indicates whether this inspection checklist item is required. The default value is true.",
            "type":"boolean"
        },
        "Score":{
            "title":"Score",
            "description":"The score that the checklist item received.",
            "type":"integer",
            "format":"int32"
        },
        "SubcategoryCode":{
            "description":"The subcategory of the inspection checklist item.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Inspection Checklist Instructions

Type: array

Title: Inspection Checklist Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Show Source

• Array of: object publicSectorInspectionChecklistItems-Instruction-item

{
    "title":"Inspection Checklist Instructions",
    "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorInspectionChecklistItems-Instruction-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with these checklist item instructions.
• ChecklistId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the instructions were created.
• InstructionCode(optional): string
  Maximum Length: 15

  The code for the instructions that are associated with an item in an inspection checklist.
• InstructionText(optional): string
  Maximum Length: 1000

  The text that includes the instructions for an inspection checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the instructions were last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the instructions.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with these checklist item instructions.",
            "type":"integer",
            "format":"int64"
        },
        "ChecklistId":{
            "description":"The unique identifier for an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "ChecklistItemId":{
            "description":"The unique identifier for an inspection checklist item.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the instructions.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the instructions were created.",
            "type":"string",
            "format":"date-time"
        },
        "InstructionCode":{
            "description":"The code for the instructions that are associated with an item in an inspection checklist.",
            "type":"string",
            "maxLength":15
        },
        "InstructionText":{
            "description":"The text that includes the instructions for an inspection checklist item.",
            "type":"string",
            "maxLength":1000
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the instructions were last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The session login associated with the user who last updated the instructions.",
            "type":"string",
            "maxLength":64
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top