Get a checklist item
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
Request
Path Parameters
-
ChecklistItemUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ChecklistId and ChecklistItemId ---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: ChecklistItem?q=AgencyId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3> -
publicSectorInspectionChecklistsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and ChecklistId ---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: publicSectorInspectionChecklists?q=AgencyId=<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).
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 : publicSectorInspectionChecklists-ChecklistItem-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with this inspection checklist item. -
CategoryCode(optional):
string
Title:
CategoryMaximum Length:30The category of the inspection checklist item. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the checklist item. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the checklist item was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:300The description of the inspection checklist item. -
Instruction(optional):
array Inspection Checklist Instructions
Title:
Inspection Checklist InstructionsThe instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the checklist item was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the checklist item. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates whether this inspection checklist item is required. The default value is true. -
Score(optional):
integer(int32)
Title:
ScoreThe score that the checklist item received. -
SubcategoryCode(optional):
string
Title:
SubcategoryMaximum Length:30The subcategory of the inspection checklist item.
Nested Schema : Inspection Checklist Instructions
Type:
arrayTitle:
Inspection Checklist InstructionsThe instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-Instruction-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the instructions. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the instructions were created. -
InstructionCode(optional):
string
Title:
InstructionsMaximum Length:15The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText(optional):
string
Title:
Instructional TextMaximum Length:1000The text that includes the instructions for an inspection checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the instructions were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the instructions. -
links(optional):
array Items
Title:
ItemsLink Relations
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.