Jump to

• Request
• Response

Create an assessment type

post

/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes

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 assessment type applies.
• AssessmentDetail: array Assessment Details
  Title: Assessment Details

  The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.
• AssessmentType(required): string
  Title: Assessment Type

  Maximum Length: 25

  The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results.
• Description(required): string
  Title: Description

  Maximum Length: 100

  The description of the assessment type.

{
    "required":[
        "AssessmentType",
        "Description"
    ],
    "type":"object",
    "properties":{
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the assessment type.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this assessment type applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "AssessmentDetail":{
            "title":"Assessment Details",
            "type":"array",
            "description":"The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAssessmentTypes-AssessmentDetail-item-post-request"
            }
        }
    }
}

Nested Schema : Assessment Details

Type: array

Title: Assessment Details

The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.

Show Source

• Array of: object schema

{
    "title":"Assessment Details",
    "type":"array",
    "description":"The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAssessmentTypes-AssessmentDetail-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 the assessment details apply.
• AssessmentCode: string
  Title: Assessment

  Maximum Length: 25

  The unique assessment code that identifies a possible outcome of an inspection.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 25

  The name of the assessment type to which the assessment details apply.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result.
• SystemResult: string
  Title: System Result

  Maximum Length: 20

  The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.

{
    "type":"object",
    "properties":{
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The name of the assessment type to which the assessment details apply.",
            "nullable":false
        },
        "AssessmentCode":{
            "title":"Assessment",
            "maxLength":"25",
            "type":"string",
            "description":"The unique assessment code that identifies a possible outcome of an inspection.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which the assessment details apply.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "SystemResult":{
            "title":"System Result",
            "maxLength":"20",
            "type":"string",
            "description":"The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.",
            "nullable":true
        }
    }
}

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 : publicSectorAssessmentTypes-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 assessment type applies.
• AssessmentDetail: array Assessment Details
  Title: Assessment Details

  The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 25

  The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the assessment type.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the assessment type was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the assessment type.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the application type was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the application type.
• 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 application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the assessment type 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 the assessment type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the assessment type.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this assessment type applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssessmentDetail":{
            "title":"Assessment Details",
            "type":"array",
            "description":"The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAssessmentTypes-AssessmentDetail-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the application type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Assessment Details

Type: array

Title: Assessment Details

The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.

Show Source

• Array of: object publicSectorAssessmentTypes-AssessmentDetail-item-response

{
    "title":"Assessment Details",
    "type":"array",
    "description":"The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAssessmentTypes-AssessmentDetail-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 : publicSectorAssessmentTypes-AssessmentDetail-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency to which the assessment details apply.
• AssessmentCode: string
  Title: Assessment

  Maximum Length: 25

  The unique assessment code that identifies a possible outcome of an inspection.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 25

  The name of the assessment type to which the assessment details apply.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the assessment details were created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the assessment details were last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemResult: string
  Title: System Result

  Maximum Length: 20

  The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentCode":{
            "title":"Assessment",
            "maxLength":"25",
            "type":"string",
            "description":"The unique assessment code that identifies a possible outcome of an inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which the assessment details apply.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The name of the assessment type to which the assessment details apply.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemResult":{
            "title":"System Result",
            "maxLength":"20",
            "type":"string",
            "description":"The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the assessment details were 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

AssessmentDetail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail

Parameters:

• publicSectorAssessmentTypesUniqID: $request.path.publicSectorAssessmentTypesUniqID

The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.

Back to Top