Get an inspection checklist
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{publicSectorInspectionChkListsUniqID}
Request
Path Parameters
-
publicSectorInspectionChkListsUniqID: integer
This is the hash key of the attributes which make up the composite key--- InspectionId, ChecklistId and AgencyId ---for the Inspection Checklists resource and used to uniquely identify an instance of Inspection Checklists. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklists collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklists.
For example: publicSectorInspectionChkLists?q=InspectionId=<value1>;ChecklistId=<value2>;AgencyId=<value3>
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).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspectionChkLists-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with the inspection checklist. -
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. -
ChecklistScore(optional):
integer(int32)
Title:
Score
The calculated score for this checklist. -
CommonComment(optional):
string
Title:
Comment
Maximum Length:1000
The comments for a specific inspection checklist from the checklist setup table. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The unique identifier for an inspection. -
links(optional):
array Items
Title:
Items
Link Relations -
MajorViolationFlag(optional):
boolean
Title:
Major Violation
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(optional):
integer(int32)
Title:
Maximum Score
The maximum score possible 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.
-
PossibleScore(optional):
integer(int32)
Title:
Possible Score
The possible score that the checklist item can receive from the checklist setup table. -
RequiredFlag(optional):
boolean
Title:
Required
Indicates whether this inspection checklist item is required. The default value is true. The information is from the checklist setup table. -
ScoringMethod(optional):
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.
Nested Schema : link
Type:
Show Source
object
-
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.