Get all rating methods
get
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- simpleSearchFinder: Finds rating methods using the specified rating method or description. Finder Variables:
- value; string; The rating method or description.
- PrimaryKey: Finds a rating method using the specified agency ID and rating method. Finder Variables:
- AgencyId; integer; The agency ID associated with the rating method.
- RatingMethod; string; The rating method name.
- simpleSearchFinder: Finds rating methods using the specified rating method or description. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRatingMethods
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRatingMethods-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe agency identifier for the public sector entity to which this rating method applies. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the rating method. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date the rating method was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of the rating method. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the rating method was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last modified the rating method. -
links(optional):
array Items
Title:
ItemsLink Relations -
RatingMethod(optional):
string
Title:
Rating MethodMaximum Length:15The 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 DetailsThe 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:
arrayTitle:
Rating Method DetailsThe 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 referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe 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 IDThe agency identifier of the public sector entity to which this rating range of scores applies. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the rating method details. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the rating method details were created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the rating method details were last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last modified the rating method details. -
links(optional):
array Items
Title:
ItemsLink Relations -
MaximumScore(optional):
integer(int32)
Title:
Maximum ScoreThe maximum numerical value to specify the range of scores for this rating. -
MinimumScore(optional):
integer(int32)
Title:
Minimum ScoreThe minimum numerical value to specify the range of scores for this rating. -
Rating(optional):
string
Title:
RatingMaximum Length:5The 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 MethodMaximum Length:15The 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).