Get all assessment types
get
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes
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 an assessment type using the specified assessment type or description. Finder Variables:
- value; string; The assessment type or description.
- PrimaryKey: Finds an assessment type using the specified agency identifier and assessment type. Finder Variables:
- AgencyId; integer; The agency identifier.
- AssessmentType; string; The assessment type.
- simpleSearchFinder: Finds an assessment type using the specified assessment type 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 : publicSectorAssessmentTypes
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates 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:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAssessmentTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency to which this assessment type applies. -
AssessmentDetail(optional):
array Assessment Details
Title:
Assessment Details
The assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes. -
AssessmentType(optional):
string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type. The assessment type consists of a list of inspection assessments and their corresponding results. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the assessment type. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the assessment type was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the assessment type. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the application type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the application type. -
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : Assessment Details
Type:
array
Title:
Assessment Details
The assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes.
Show Source
Nested Schema : publicSectorAssessmentTypes-AssessmentDetail-item
Type:
Show Source
object
-
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.
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.