Jump to

• Request
• Response

Update an inspection checklist

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{InspectionChklistKey}

Request

Path Parameters

• InspectionChklistKey(required): integer(int64)
  The unique identifier for an inspection checklist.

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

• ChecklistResult: string
  Title: Result

  Maximum Length: 15

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

  The calculated score for this checklist.
• CommonComment: string
  Title: Comment

  Maximum Length: 1000

  The comments for a specific inspection checklist from the checklist setup table.
• MajorViolationFlag: boolean
  Title: Major Violation

  Maximum Length: 1

  Indicates whether a failing result for the checklist constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table.
• NumberMajorViolations: integer (int32)
  The calculated number of major violations for the checklist.

{
    "type":"object",
    "properties":{
        "ChecklistResult":{
            "title":"Result",
            "maxLength":"15",
            "type":"string",
            "description":"The result for this checklist, such as Pass, Fail, Yes, No, and so on.",
            "nullable":true
        },
        "ChecklistScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score for this checklist.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "CommonComment":{
            "title":"Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments for a specific inspection checklist from the checklist setup table.",
            "nullable":true
        },
        "MajorViolationFlag":{
            "title":"Major Violation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table.",
            "nullable":true
        },
        "NumberMajorViolations":{
            "type":"integer",
            "description":"The calculated number of major violations for the checklist.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        }
    }
}

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 : publicSectorInspectionChkLists-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.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 15

  The name of the assessment type used for the inspection checklist from the checklist setup table.
• ChecklistId: string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistName: string
  Title: Checklist Name

  Maximum Length: 100

  The description of an inspection checklist from the checklist setup table.
• ChecklistResult: string
  Title: Result

  Maximum Length: 15

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

  The calculated score for this checklist.
• CommonComment: string
  Title: Comment

  Maximum Length: 1000

  The comments for a specific inspection checklist from the checklist setup table.
• InspectionChklistKey: integer (int64)
  The unique identifier for an inspection checklist.
• InspectionChklistPuid: string
  Maximum Length: 480

  The persistent unique identifier for an inspection checklist.
• InspectionId: string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for an inspection.
• InspectionKey: integer (int64)
  The unique identifier for an inspection.
• InspectionPuid: string
  Maximum Length: 480

  The persistent unique identifier for an inspection.
• 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 constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maximum score possible for an inspection checklist from the checklist setup table.
• MinimumPassingScore: integer (int32)
  Title: Minimum Passing Score

  The minimum checklist score that is considered a passing result from the checklist setup table.
• NumberMajorViolations: integer (int32)
  The calculated number of major violations for the checklist.
• PossibleScore: integer (int32)
  Title: Possible Score

  The possible score that the checklist item can receive from the checklist setup table.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Indicates whether this inspection checklist item is required. The default value is true. The information is from the checklist setup table.
• ScoringMethod: string
  Title: Score Method

  Maximum Length: 15

  The method used for scoring a checklist from the checklist setup table. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.

{
    "type":"object",
    "properties":{
        "MinimumPassingScore":{
            "title":"Minimum Passing Score",
            "type":"integer",
            "description":"The minimum checklist score that is considered a passing result from the checklist setup table.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection checklist.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for an inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "InspectionChklistPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The persistent unique identifier for an inspection checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionChklistKey":{
            "type":"integer",
            "description":"The unique identifier for an inspection checklist.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "NumberMajorViolations":{
            "type":"integer",
            "description":"The calculated number of major violations for the checklist.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":"100",
            "type":"string",
            "description":"The description of an inspection checklist from the checklist setup table.",
            "nullable":false,
            "x-queryable":true
        },
        "PossibleScore":{
            "title":"Possible Score",
            "type":"integer",
            "description":"The possible score that the checklist item can receive from the checklist setup table.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ChecklistScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score for this checklist.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "CommonComment":{
            "title":"Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments for a specific inspection checklist from the checklist setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "MajorViolationFlag":{
            "title":"Major Violation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"15",
            "type":"string",
            "description":"The name of the assessment type used for the inspection checklist from the checklist setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The persistent unique identifier for an inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistResult":{
            "title":"Result",
            "maxLength":"15",
            "type":"string",
            "description":"The result for this checklist, such as Pass, Fail, Yes, No, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique identifier for an inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. The default value is true. The information is from the checklist setup table.",
            "nullable":true,
            "x-queryable":true
        },
        "ScoringMethod":{
            "title":"Score Method",
            "maxLength":"15",
            "type":"string",
            "description":"The method used for scoring a checklist from the checklist setup table. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maximum score possible for an inspection checklist from the checklist setup table.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "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