Create an inspection group line
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for a public sector agency. -
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(required): 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(required): string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection, such as an electrical or plumbing inspection. -
Required(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 : publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the inspection. -
DependentInspectionType: string
Title:
Inspection Type
Maximum Length:15
The dependent inspection type for 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.
Response
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-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.
Links
- InspectionGrpLnDependency
-
Parameters:
- publicSectorInspectionGroupLinesUniqID:
$request.path.publicSectorInspectionGroupLinesUniqID
The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group. - publicSectorInspectionGroupLinesUniqID: