Jump to

• Request
• Response

Update a checklist item

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorInspectionChecklistItemsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, ChecklistId and ChecklistItemId ---for the Inspection Checklist Items resource and used to uniquely identify an instance of Inspection Checklist Items. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Items.
  
  For example: publicSectorInspectionChecklistItems?q=AgencyId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3>

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
  Title: Category

  Maximum Length: 30

  The category of the inspection checklist item.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  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 inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
• 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
  Title: Major Violation

  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
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with this inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item.",
            "title":"Description"
        },
        "Instruction":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
            },
            "type":"array",
            "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
            "title":"Inspection Checklist Instructions"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the checklist item.",
            "title":"Last Updated By"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "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.",
            "title":"Major Violation"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. The default value is true.",
            "title":"Required"
        },
        "Score":{
            "format":"int32",
            "type":"integer",
            "description":"The score that the checklist item received.",
            "title":"Score"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item.",
            "title":"Subcategory"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Instructions

Type: array

Title: Inspection Checklist Instructions

The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.

Show Source

• Array of: object publicSectorInspectionChecklistItems-Instruction-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
    },
    "type":"array",
    "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
    "title":"Inspection Checklist Instructions"
}

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 : 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
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  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
  Title: Instructions

  Maximum Length: 15

  The code for the instructions that are associated with an item in an inspection checklist.
• InstructionText(optional): string
  Title: Instructional Text

  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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with these checklist item instructions.",
            "title":"Agency ID"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the instructions.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were created.",
            "title":"Creation Date"
        },
        "InstructionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code for the instructions that are associated with an item in an inspection checklist.",
            "title":"Instructions"
        },
        "InstructionText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text that includes the instructions for an inspection checklist item.",
            "title":"Instructional Text"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the instructions.",
            "title":"Last Updated By"
        },
        "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 : 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
  Title: Category

  Maximum Length: 30

  The category of the inspection checklist item.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  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 inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
• 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
  Title: Major Violation

  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
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with this inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item.",
            "title":"Description"
        },
        "Instruction":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
            },
            "type":"array",
            "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
            "title":"Inspection Checklist Instructions"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the checklist item.",
            "title":"Last Updated By"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "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.",
            "title":"Major Violation"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. The default value is true.",
            "title":"Required"
        },
        "Score":{
            "format":"int32",
            "type":"integer",
            "description":"The score that the checklist item received.",
            "title":"Score"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item.",
            "title":"Subcategory"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Instructions

Type: array

Title: Inspection Checklist Instructions

The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.

Show Source

• Array of: object publicSectorInspectionChecklistItems-Instruction-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklistItems-Instruction-item"
    },
    "type":"array",
    "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
    "title":"Inspection Checklist Instructions"
}

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 : 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
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  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
  Title: Instructions

  Maximum Length: 15

  The code for the instructions that are associated with an item in an inspection checklist.
• InstructionText(optional): string
  Title: Instructional Text

  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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with these checklist item instructions.",
            "title":"Agency ID"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the instructions.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were created.",
            "title":"Creation Date"
        },
        "InstructionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code for the instructions that are associated with an item in an inspection checklist.",
            "title":"Instructions"
        },
        "InstructionText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text that includes the instructions for an inspection checklist item.",
            "title":"Instructional Text"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the instructions.",
            "title":"Last Updated By"
        },
        "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