Create an inspection checklist group
post
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups
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 the public sector agency to which this inspection checklist group applies. -
ChecklistGroup(required): string
Title:
Checklist Group
Maximum Length:15
The name that uniquely identifies an inspection checklist group. -
ChecklistGroupLine: array
Inspection Checklist Group Lines
Title:
Inspection Checklist Group Lines
The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group. -
Description(required): string
Title:
Description
Maximum Length:100
The description of the inspection checklist group.
Nested Schema : Inspection Checklist Group Lines
Type:
array
Title:
Inspection Checklist Group Lines
The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this checklist group line applies. -
ChecklistGroup: string
Title:
Checklist Group
Maximum Length:15
The name that uniquely identifies an inspection checklist group. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The name that uniquely identifies an inspection checklist.
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 : publicSectorChecklistGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this inspection checklist group applies. -
ChecklistGroup: string
Title:
Checklist Group
Maximum Length:15
The name that uniquely identifies an inspection checklist group. -
ChecklistGroupLine: array
Inspection Checklist Group Lines
Title:
Inspection Checklist Group Lines
The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this inspection checklist group. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inspection checklist group was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the inspection checklist group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inspection checklist group was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inspection checklist group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Inspection Checklist Group Lines
Type:
array
Title:
Inspection Checklist Group Lines
The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorChecklistGroups-ChecklistGroupLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this checklist group line applies. -
ChecklistGroup: string
Title:
Checklist Group
Maximum Length:15
The name that uniquely identifies an inspection checklist group. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The name that uniquely identifies an inspection checklist. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the checklist group line to the checklist group. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date that the checklist group line was added to the checklist group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date that the checklist group line was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the checklist group line. -
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
- ChecklistGroupLine
-
Parameters:
- publicSectorChecklistGroupsUniqID:
$request.path.publicSectorChecklistGroupsUniqID
The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group. - publicSectorChecklistGroupsUniqID: