Jump to

• Request
• Response

Update a rating range of scores

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorRatingMethods-RatingMethodDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this rating range of scores applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the rating method details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating(optional): string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "title":"Minimum Score"
        },
        "Rating":{
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "title":"Rating"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "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 : publicSectorRatingMethods-RatingMethodDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this rating range of scores applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the rating method details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating(optional): string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "title":"Minimum Score"
        },
        "Rating":{
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "title":"Rating"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "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