Jump to

• Request
• Response

Get an inspection checklist with details

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListDetails/{publicSectorInspectionChkListDetailsUniqID}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• AssessmentType(optional): string
  Title: Assessment Type

  Maximum Length: 15

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

  Maximum Length: 15

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

  Maximum Length: 100

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

  Maximum Length: 15

  The result for this checklist, such as Pass, Fail, Yes, No, and so on.
• ChecklistResultDescr(optional): string
  Maximum Length: 100

  The description of the checklist results, such as Failing Result. The description comes from the PSC_INS_ASSESSMENT_DTL_VL.Description.
• ChecklistScore(optional): integer(int32)
  Title: Score

  The calculated score for the checklist.
• CommonComment(optional): string
  Title: Comment

  Maximum Length: 2000

  The comments for a specific inspection checklist from the checklist setup table.
• InspectionId(optional): string
  Title: Inspection

  Maximum Length: 255

  The unique identifier for an inspection.
• ItemResourceCount(optional): number
  The calculated number of checklist items with results scores in an inspection checklist.
• ItemTotalCount(optional): number
  The calculated number of checklist items in an inspection checklist.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

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

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

  Maximum Length: 1

  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.

{
    "properties":{
        "AssessmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the assessment type used for the inspection checklist from the checklist setup table.",
            "title":"Assessment Type"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistName":{
            "maxLength":100,
            "type":"string",
            "description":"The description of an inspection checklist from the checklist setup table.",
            "title":"Checklist Name"
        },
        "ChecklistResult":{
            "maxLength":15,
            "type":"string",
            "description":"The result for this checklist, such as Pass, Fail, Yes, No, and so on.",
            "title":"Result"
        },
        "ChecklistResultDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the checklist results, such as Failing Result. The description comes from the PSC_INS_ASSESSMENT_DTL_VL.Description."
        },
        "ChecklistScore":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated score for the checklist.",
            "title":"Score"
        },
        "CommonComment":{
            "maxLength":2000,
            "type":"string",
            "description":"The comments for a specific inspection checklist from the checklist setup table.",
            "title":"Comment"
        },
        "InspectionId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for an inspection.",
            "title":"Inspection"
        },
        "ItemResourceCount":{
            "type":"number",
            "description":"The calculated number of checklist items with results scores in an inspection checklist."
        },
        "ItemTotalCount":{
            "type":"number",
            "description":"The calculated number of checklist items in an inspection checklist."
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum possible score for an inspection checklist from the checklist setup table.",
            "title":"Maximum Score"
        },
        "MinimumPassingScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum checklist score that is considered a passing result from the checklist setup table.",
            "title":"Minimum Passing Score"
        },
        "NumberMajorViolations":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated number of major violations for the checklist."
        },
        "ScoringMethod":{
            "maxLength":1,
            "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.",
            "title":"Score Method"
        },
        "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