Jump to

• Request
• Response

Update an assessment definition

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorAssessmentDetailsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, AssessmentType and AssessmentCode ---for the Assessment Details resource and used to uniquely identify an instance of Assessment Details. The client should not generate the hash key value. Instead, the client should query on the Assessment Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Assessment Details.
  
  For example: publicSectorAssessmentDetails?q=AgencyId=<value1>;AssessmentType=<value2>;AssessmentCode=<value3>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAssessmentDetails-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which the assessment details apply.",
            "title":"Agency ID"
        },
        "AssessmentCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique assessment code that identifies a possible outcome of an inspection.",
            "title":"Assessment"
        },
        "AssessmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the assessment type to which the assessment details apply.",
            "title":"Assessment Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the assessment details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "title":"Creation Date"
        },
        "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.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the assessment details.",
            "title":"Last Updated By"
        },
        "SystemResult":{
            "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.",
            "title":"System Result"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAssessmentDetails-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which the assessment details apply.",
            "title":"Agency ID"
        },
        "AssessmentCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique assessment code that identifies a possible outcome of an inspection.",
            "title":"Assessment"
        },
        "AssessmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the assessment type to which the assessment details apply.",
            "title":"Assessment Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the assessment details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "title":"Creation Date"
        },
        "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.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the assessment details.",
            "title":"Last Updated By"
        },
        "SystemResult":{
            "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.",
            "title":"System Result"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top