Jump to

• Request
• Response

Update an assessment code

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}

Request

Path Parameters

• AssessmentDetailUniqID(required): string
  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: AssessmentDetail?q=AgencyId=<value1>;AssessmentType=<value2>;AssessmentCode=<value3>
• 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>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "SystemResult":{
            "title":"System Result",
            "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.",
            "nullable":true
        },
        "Description":{
            "title":"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.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorAssessmentTypes-AssessmentDetail-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentCode":{
            "title":"Assessment",
            "maxLength":"25",
            "type":"string",
            "description":"The unique assessment code that identifies a possible outcome of an inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which the assessment details apply.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The name of the assessment type to which the assessment details apply.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemResult":{
            "title":"System Result",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top