Get an assessment type
get
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
Request
Path Parameters
-
publicSectorAssessmentTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and AssessmentType ---for the Assessment Types resource and used to uniquely identify an instance of Assessment Types. The client should not generate the hash key value. Instead, the client should query on the Assessment Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Assessment Types.
For example: publicSectorAssessmentTypes?q=AgencyId=<value1>;AssessmentType=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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: