Create an assessment code
post
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail
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-AssessmentDetail-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency to which the assessment details apply. -
AssessmentCode(optional):
string
Title:
Assessment
Maximum Length:15
The unique assessment code that identifies a possible outcome of an inspection. -
AssessmentType(optional):
string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type to which the assessment details apply. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the assessment details. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the assessment details were created. -
Description(optional):
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(optional):
string(date-time)
Title:
Last Updated Date
The date when the assessment details were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the assessment details. -
links(optional):
array Items
Title:
Items
Link Relations -
SystemResult(optional):
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 : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The 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-AssessmentDetail-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency to which the assessment details apply. -
AssessmentCode(optional):
string
Title:
Assessment
Maximum Length:15
The unique assessment code that identifies a possible outcome of an inspection. -
AssessmentType(optional):
string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type to which the assessment details apply. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the assessment details. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the assessment details were created. -
Description(optional):
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(optional):
string(date-time)
Title:
Last Updated Date
The date when the assessment details were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the assessment details. -
links(optional):
array Items
Title:
Items
Link Relations -
SystemResult(optional):
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 : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.