Get all inspection group lines
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
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 an inspection group line using the specified agency ID, inspection group, and inspection type.
Finder Variables:- AgencyId; integer; The agency ID.
- InspectionGroup; string; The inspection group.
- InspectionType; string; The inspection type.
- PrimaryKey: Finds an inspection group line using the specified agency ID, inspection group, and inspection type.
-
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 a public sector agency.
- CreationDate; string; The date when an inspection was added to the group.
- FinalInspectionFlag; boolean; Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
- InspectionGroup; string; The unique identifier for a group of inspections that are associated with a record type, such as a permit.
- InspectionType; string; The unique identifier for a type of inspection, such as an electrical or plumbing inspection.
- LastUpdateDate; string; The date when an inspection in the group was last updated.
- Required; boolean; Indicates whether the inspection is required. The default value is false.
-
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 : publicSectorInspectionGroupLines
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 : publicSectorInspectionGroupLines-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for a public sector agency. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when an inspection was added to the group. -
DependentInspectionTypeCode: string
Maximum Length:
2000
The dependent inspection types defined for this inspection type -
DependentInspectionTypeDescr: string
Maximum Length:
2500
The descriptions of the dependent inspection types defined for this inspection type. -
FinalInspectionFlag: boolean
Title:
Final Inspection
Maximum Length:1
Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection. -
InspectionGroup: string
Title:
Inspection Group
Maximum Length:15
The unique identifier for a group of inspections that are associated with a record type, such as a permit. -
InspectionGrpLnDependency: array
Inspection Type Dependencies
Title:
Inspection Type Dependencies
The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection, such as an electrical or plumbing inspection. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when an inspection in the group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Required: boolean
Title:
Required
Maximum Length:1
Indicates whether the inspection is required. The default value is false.
Nested Schema : Inspection Type Dependencies
Type:
array
Title:
Inspection Type Dependencies
The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the inspection. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the dependent inspection type was added to the inspection type. -
DependentInspectionType: string
Title:
Inspection Type
Maximum Length:15
The dependent inspection type for the inspection type. -
Description: string
Read Only:
true
Maximum Length:255
The description of the inspection type. -
InspectionGroup: string
Title:
Inspection Group
Maximum Length:15
The inspection group that includes the dependent inspection type. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The inspection type for which the dependent inspection type is defined. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the dependent inspection type was last updated. -
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.