Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "ChecklistGroup",
        "Description"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the inspection checklist group.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this inspection checklist group applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            }
        },
        "ChecklistGroupLine":{
            "title":"Inspection Checklist Group Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorChecklistGroups-ChecklistGroupLine-item-post-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Inspection Checklist Group Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorChecklistGroups-ChecklistGroupLine-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist group line applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorChecklistGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the inspection checklist group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inspection checklist group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this inspection checklist group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the inspection checklist group.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this inspection checklist group applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ChecklistGroupLine":{
            "title":"Inspection Checklist Group Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorChecklistGroups-ChecklistGroupLine-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inspection checklist group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorChecklistGroups-ChecklistGroupLine-item-response

{
    "title":"Inspection Checklist Group Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorChecklistGroups-ChecklistGroupLine-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorChecklistGroups-ChecklistGroupLine-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the checklist group line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date that the checklist group line was added to the checklist group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the checklist group line to the checklist group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist group line applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the checklist group line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ChecklistGroupLine

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/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.

Back to Top