Jump to

• Request
• Response

Update an inspection checklist item

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}

Request

Path Parameters

• publicSectorInspectionMobileChkListItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- SetupAgencyId, SetupChecklistId, SetupChecklistItemId and InspectionClItemKey ---for the Inspection Mobile Checklist Items resource and used to uniquely identify an instance of Inspection Mobile Checklist Items. The client should not generate the hash key value. Instead, the client should query on the Inspection Mobile Checklist Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Mobile Checklist Items.
  
  For example: publicSectorInspectionMobileChkListItems?q=SetupAgencyId=<value1>;SetupChecklistId=<value2>;SetupChecklistItemId=<value3>;InspectionClItemKey=<value4>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChecklistItemResult: string
  Title: Result

  Maximum Length: 15

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

  The score received for this checklist item.
• MajorViolationFlag: boolean
  Title: Major Violation

  Maximum Length: 1

  Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.

{
    "type":"object",
    "properties":{
        "ChecklistItemResult":{
            "title":"Result",
            "maxLength":"15",
            "type":"string",
            "description":"The result for this checklist item, such as Pass, Fail, Yes, No, and so on.",
            "nullable":true
        },
        "ChecklistItemScore":{
            "title":"Score",
            "type":"integer",
            "description":"The score received for this checklist item.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "MajorViolationFlag":{
            "title":"Major Violation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorInspectionMobileChkListItems-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 30

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

  Maximum Length: 15

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

  Maximum Length: 15

  The unique identifier for the inspection checklist item.
• ChecklistItemName: 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: string
  Title: Result

  Maximum Length: 15

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

  The score received for this checklist item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the inspection checklist item was created.
• InspectionClItemKey: integer (int64)
  The unique identifier for the inspection checklist item.
• InspectionId: string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for the inspection.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the inspection checklist item was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorViolationFlag: boolean
  Title: Major Violation

  Maximum Length: 1

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

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

  Maximum Length: 1

  Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.
• SetupAgencyId: integer (int32)
  Read Only: true

  The identifier for the public sector agency associated with the setup of inspection checklist item.
• SetupChecklistId: string
  Read Only: true

  Maximum Length: 15

  The unique identifier for the setup of inspection checklist.
• SetupChecklistItemId: string
  Read Only: true

  Maximum Length: 15

  The unique identifier for the setup of inspection checklist item.
• SetupMajorViolationFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a failing result for the checklist item constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. This is copied from the checklist item setup information.
• SetupScore: integer (int32)
  Read Only: true

  The score that the checklist item received. This is copied from the checklist item setup information.
• SubcategoryCode: string
  Title: Subcategory

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the inspection checklist item. This is copied from the checklist item setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inspection checklist item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SetupMajorViolationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. This is copied from the checklist item setup information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubcategoryCode":{
            "title":"Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The subcategory of the inspection checklist item. This is copied from the checklist item setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection checklist item.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "SetupAgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the setup of inspection checklist item.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for the inspection checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "ChecklistItemResult":{
            "title":"Result",
            "maxLength":"15",
            "type":"string",
            "description":"The result for this checklist item, such as Pass, Fail, Yes, No, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistItemScore":{
            "title":"Score",
            "type":"integer",
            "description":"The score received for this checklist item.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ChecklistItemName":{
            "title":"Checklist Item Name",
            "maxLength":"300",
            "type":"string",
            "description":"The description of the inspection checklist item. This is copied from the checklist item setup table.",
            "nullable":false,
            "x-queryable":true
        },
        "PossibleScore":{
            "title":"Possible Score",
            "type":"integer",
            "description":"The maximum possible score for the checklist item. This is copied from the checklist item setup table.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "MajorViolationFlag":{
            "title":"Major Violation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistItemId":{
            "title":"Checklist Item",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for the inspection checklist item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetupScore":{
            "type":"integer",
            "description":"The score that the checklist item received. This is copied from the checklist item setup information.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "SetupChecklistId":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for the setup of inspection checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "SetupChecklistItemId":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for the setup of inspection checklist item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionClItemKey":{
            "type":"integer",
            "description":"The unique identifier for the inspection checklist item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inspection checklist item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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