Get all checklists
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a checklist using the specified agency identifier and checklist identifier.
Finder Variables:- AgencyId; integer; The agency identifier.
- ChecklistId; string; The checklist identifier.
- simpleSearchFinder: Finds checklists using the specified checklist ID or description.
Finder Variables:- value; string; The checklist ID or description.
- PrimaryKey: Finds a checklist using the specified agency identifier and checklist identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier for the public sector agency associated with this inspection checklist.
- AssessmentType; string; The name of the assessment type used for the inspection checklist.
- ChecklistId; string; The unique identifier for an inspection checklist.
- CommonComment; string; The comments for a specific inspection checklist.
- CreatedBy; string; The user who created the checklist.
- CreationDate; string; The date when the checklist was created.
- Description; string; The description of an inspection checklist.
- EnabledFlag; boolean; Indicates whether the inspection checklist is available to be used. The default value is true.
- LastUpdateDate; string; The date when the checklist was last updated.
- LastUpdatedBy; string; The session login associated with the user who last updated the checklist.
- MajorViolationFlag; boolean; Indicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.
- MaximumScore; integer; The maximum score possible for an inspection checklist.
- MinimumPassingScore; integer; The minimum checklist score that is considered a passing result.
- RequiredFlag; boolean; Indicates whether this inspection checklist is required. The default value is true.
- Score; integer; The calculated score of the checklist.
- ScoringMethod; string; The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorInspectionChecklists
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionChecklists-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with this inspection checklist. -
AssessmentType: string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type used for the inspection checklist. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItem: array
Inspection Checklist Items
Title:
Inspection Checklist Items
The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical. -
CommonComment: string
Title:
Comment
Maximum Length:1000
The comments for a specific inspection checklist. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the checklist. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the checklist was created. -
Description: string
Title:
Description
Maximum Length:100
The description of an inspection checklist. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the inspection checklist is available to be used. The default value is true. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the checklist was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The session login associated with the user who last updated the checklist. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorViolationFlag: boolean
Title:
Major Violation
Maximum Length:1
Default Value:true
Indicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
MaximumScore: integer
(int32)
Title:
Maximum Score
The maximum score possible for an inspection checklist. -
MinimumPassingScore: integer
(int32)
Title:
Minimum Passing Score
The minimum checklist score that is considered a passing result. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Default Value:true
Indicates whether this inspection checklist is required. The default value is true. -
Score: integer
(int32)
Title:
Score
The calculated score of the checklist. -
ScoringMethod: string
Title:
Scoring Method
Maximum Length:15
The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
Nested Schema : Inspection Checklist Items
Type:
array
Title:
Inspection Checklist Items
The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with this inspection checklist item. -
CategoryCode: string
Title:
Category
Maximum Length:30
The category of the inspection checklist item. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the checklist item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the checklist item was created. -
Description: string
Title:
Description
Maximum Length:300
The description of the inspection checklist item. -
Instruction: array
Inspection Checklist Instructions
Title:
Inspection Checklist Instructions
The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the checklist item was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The session login associated with the user who last updated the checklist item. -
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 consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates whether this inspection checklist item is required. The default value is true. -
Score: integer
(int32)
Title:
Score
The score that the checklist item received. -
SubcategoryCode: string
Title:
Subcategory
Maximum Length:30
The subcategory of the inspection checklist item.
Nested Schema : Inspection Checklist Instructions
Type:
array
Title:
Inspection Checklist Instructions
The 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-Instruction-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the instructions. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the instructions were created. -
InstructionCode: string
Title:
Instructions
Maximum Length:15
The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText: string
Title:
Instructional Text
Maximum Length:1000
The text that includes the instructions for an inspection checklist item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the instructions were last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The session login associated with the user who last updated the instructions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.