Create a checklist item
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems
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 associated with this inspection checklist item. -
CategoryCode: string
Title:
Category
Maximum Length:30
The category of the inspection checklist item. -
ChecklistId(required): string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId(required): string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
Description(required): 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. -
MajorViolationFlag(required): 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(required): 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 : schema
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorInspectionChecklistItems-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 : publicSectorInspectionChecklistItems-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.
Links
- Instruction
-
Parameters:
- publicSectorInspectionChecklistItemsUniqID:
$request.path.publicSectorInspectionChecklistItemsUniqID
The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item. - publicSectorInspectionChecklistItemsUniqID: