Jump to

• Request
• Response

Update an inspection checklist item

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{publicSectorInspectionChkListItemsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorInspectionChkListItemsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- InspectionId, ChecklistId, ChecklistItemId and AgencyId ---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: publicSectorInspectionChkListItems?q=InspectionId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3>;AgencyId=<value4>

Body ()

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

Root Schema : publicSectorInspectionChkListItems-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the inspection checklist item.
• CategoryCode(optional): string
  Title: Category

  Maximum Length: 30

  The category of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

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

  Maximum Length: 15

  The unique identifier for the inspection checklist item.
• ChecklistItemName(optional): string
  Title: Checklist Item Name

  Maximum Length: 300

  The description of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistItemResult(optional): string
  Title: Result

  Maximum Length: 15

  The result for this checklist item, such as Pass, Fail, Yes, No, and so on.
• ChecklistItemScore(optional): integer(int32)
  Title: Score

  The calculated score for this checklist item.
• InspectionId(optional): string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for the inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Title: Major Violation

  Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.
• PossibleScore(optional): integer(int32)
  Title: Possible Score

  The maximum possible score for the checklist item. This is copied from the checklist item setup table.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.
• SubcategoryCode(optional): string
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item. This is copied from the checklist item setup table.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist item.",
            "title":"Checklist Item"
        },
        "ChecklistItemName":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Checklist Item Name"
        },
        "ChecklistItemResult":{
            "maxLength":15,
            "type":"string",
            "description":"The result for this checklist item, such as Pass, Fail, Yes, No, and so on.",
            "title":"Result"
        },
        "ChecklistItemScore":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated score for this checklist item.",
            "title":"Score"
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the inspection.",
            "title":"Inspection"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.",
            "title":"Major Violation"
        },
        "PossibleScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum possible score for the checklist item. This is copied from the checklist item setup table.",
            "title":"Possible Score"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.",
            "title":"Required"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Subcategory"
        },
        "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 : publicSectorInspectionChkListItems-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the inspection checklist item.
• CategoryCode(optional): string
  Title: Category

  Maximum Length: 30

  The category of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

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

  Maximum Length: 15

  The unique identifier for the inspection checklist item.
• ChecklistItemName(optional): string
  Title: Checklist Item Name

  Maximum Length: 300

  The description of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistItemResult(optional): string
  Title: Result

  Maximum Length: 15

  The result for this checklist item, such as Pass, Fail, Yes, No, and so on.
• ChecklistItemScore(optional): integer(int32)
  Title: Score

  The calculated score for this checklist item.
• InspectionId(optional): string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for the inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Title: Major Violation

  Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.
• PossibleScore(optional): integer(int32)
  Title: Possible Score

  The maximum possible score for the checklist item. This is copied from the checklist item setup table.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.
• SubcategoryCode(optional): string
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item. This is copied from the checklist item setup table.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist item.",
            "title":"Checklist Item"
        },
        "ChecklistItemName":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Checklist Item Name"
        },
        "ChecklistItemResult":{
            "maxLength":15,
            "type":"string",
            "description":"The result for this checklist item, such as Pass, Fail, Yes, No, and so on.",
            "title":"Result"
        },
        "ChecklistItemScore":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated score for this checklist item.",
            "title":"Score"
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the inspection.",
            "title":"Inspection"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.",
            "title":"Major Violation"
        },
        "PossibleScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum possible score for the checklist item. This is copied from the checklist item setup table.",
            "title":"Possible Score"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.",
            "title":"Required"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Subcategory"
        },
        "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