Update an assessment type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorAssessmentTypesUniqID: integer
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAssessmentTypes-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this assessment type applies. -
AssessmentDetail(optional):
array Assessment Details
Title:
Assessment DetailsThe assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the assessment type. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the assessment type was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of the assessment type. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the application type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the application type. -
links(optional):
array Items
Title:
ItemsLink Relations
Nested Schema : Assessment Details
Type:
arrayTitle:
Assessment DetailsThe assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes.
Show Source
Nested Schema : publicSectorAssessmentTypes-AssessmentDetail-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which the assessment details apply. -
AssessmentCode(optional):
string
Title:
AssessmentMaximum Length:15The unique assessment code that identifies a possible outcome of an inspection. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type to which the assessment details apply. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the assessment details. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the assessment details were created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the assessment details were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the assessment details. -
links(optional):
array Items
Title:
ItemsLink Relations -
SystemResult(optional):
string
Title:
System ResultMaximum Length:20The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAssessmentTypes-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this assessment type applies. -
AssessmentDetail(optional):
array Assessment Details
Title:
Assessment DetailsThe assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the assessment type. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the assessment type was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of the assessment type. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the application type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the application type. -
links(optional):
array Items
Title:
ItemsLink Relations
Nested Schema : Assessment Details
Type:
arrayTitle:
Assessment DetailsThe assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes.
Show Source
Nested Schema : publicSectorAssessmentTypes-AssessmentDetail-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which the assessment details apply. -
AssessmentCode(optional):
string
Title:
AssessmentMaximum Length:15The unique assessment code that identifies a possible outcome of an inspection. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type to which the assessment details apply. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the assessment details. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the assessment details were created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of the assessment code. For example, an assessment of Fail could have a description such as Failing Result. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the assessment details were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the assessment details. -
links(optional):
array Items
Title:
ItemsLink Relations -
SystemResult(optional):
string
Title:
System ResultMaximum Length:20The result code associated with an assessment code. The result code determines whether an inspection should received a full score or no score.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.