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
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 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.
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
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 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.
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 : publicSectorAssessmentTypes-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 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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAssessmentTypes-AssessmentDetail-item-response
Type:
Show Source
object
-
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.
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
- 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. - publicSectorAssessmentTypesUniqID: