Update a rating method
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRatingMethods-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The agency identifier for the public sector entity to which this rating method applies. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the rating method. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date the rating method was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the rating method. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the rating method was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the rating method. -
links(optional):
array Items
Title:
Items
Link Relations -
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). -
RatingMethodDetail(optional):
array Rating Method Details
Title:
Rating Method Details
The rating methods resource is used to view, create, delete, or modify a rating method. A rating method identifies the ways in which the object of inspection can be rated. For a given rating method, there can be one or more rating ranges. When using scoring for inspections, rating methods are required. Rating methods are used at the inspection type level and are not required at the checklist or checklist item levels.
Nested Schema : Rating Method Details
Type:
array
Title:
Rating Method Details
The rating methods resource is used to view, create, delete, or modify a rating method. A rating method identifies the ways in which the object of inspection can be rated. For a given rating method, there can be one or more rating ranges. When using scoring for inspections, rating methods are required. Rating methods are used at the inspection type level and are not required at the checklist or checklist item levels.
Show Source
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.
Nested Schema : publicSectorRatingMethods-RatingMethodDetail-item
Type:
Show Source
object
-
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).
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 : publicSectorRatingMethods-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The agency identifier for the public sector entity to which this rating method applies. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the rating method. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date the rating method was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the rating method. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the rating method was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the rating method. -
links(optional):
array Items
Title:
Items
Link Relations -
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). -
RatingMethodDetail(optional):
array Rating Method Details
Title:
Rating Method Details
The rating methods resource is used to view, create, delete, or modify a rating method. A rating method identifies the ways in which the object of inspection can be rated. For a given rating method, there can be one or more rating ranges. When using scoring for inspections, rating methods are required. Rating methods are used at the inspection type level and are not required at the checklist or checklist item levels.
Nested Schema : Rating Method Details
Type:
array
Title:
Rating Method Details
The rating methods resource is used to view, create, delete, or modify a rating method. A rating method identifies the ways in which the object of inspection can be rated. For a given rating method, there can be one or more rating ranges. When using scoring for inspections, rating methods are required. Rating methods are used at the inspection type level and are not required at the checklist or checklist item levels.
Show Source
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.
Nested Schema : publicSectorRatingMethods-RatingMethodDetail-item
Type:
Show Source
object
-
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).