Get a drop scheme type
get
/fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}
Request
Path Parameters
-
DropSchemeId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
DropSchemeTypeId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : dropSchemes-dropSchemeTypes-item-response
Type:
Show Source
object
-
DropPeriodAttributeCode: string
Title:
Period Attribute Code
Maximum Length:30
The unique code of the drop type attribute. -
DropPeriodAttributeId: integer
(int64)
Title:
Drop Attribute ID
The unique identifier for the drop attribute that's associated with the drop scheme. -
DropPeriodAttributeName: string
Title:
Period Attribute Name
Read Only:true
Maximum Length:50
The name of the drop type attribute. -
DropPeriodAttributeTypeCode: string
Title:
Drop Attribute Type
Read Only:true
Maximum Length:30
The type of the drop type attribute. -
DropPeriodAttributeTypeMeaning: string
Title:
Drop Attribute Type Meaning
Read Only:true
Maximum Length:80
The meaning of the drop attribute type. -
DropSchemeTypeId: integer
(int64)
Title:
Drop Scheme Type ID
Read Only:true
The unique identifier for the drop scheme type record. -
dropTypeResults: array
Drop Scheme Type Results
Title:
Drop Scheme Type Results
The drop scheme type results resource maps penalty drop type to penalty result. -
DropTypeSequenceNumber: integer
(int32)
Title:
Drop Type Sequence
The sequence of the drop scheme type record. -
EnrollmentStatusCode: string
Title:
Enrollment Status
Maximum Length:30
The enrollment status for the drop scheme type record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status Meaning
Read Only:true
Maximum Length:80
The meaning of the enrollment status. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Drop Scheme Type Results
Type:
array
Title:
Drop Scheme Type Results
The drop scheme type results resource maps penalty drop type to penalty result.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : dropSchemes-dropSchemeTypes-dropTypeResults-item-response
Type:
Show Source
object
-
DefaultFlag: boolean
Title:
Default
Maximum Length:1
Indicates whether the default value is true or false for the drop type result. -
DropPeriodAttributeName: string
Title:
Period Attribute Name
Read Only:true
Maximum Length:50
The name of the drop attribute for which this result is defined. -
DropTypeResultId: integer
(int64)
Title:
Drop Type Result ID
Read Only:true
The unique identifier for the drop type result record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultGradePoints: number
Title:
Result Grade Points
Read Only:true
The grade points associated with the drop type result. -
ResultNumericValue: number
Title:
Result Numeric Value
The numeric value associated with the drop type result. -
ResultOutcomeCode: string
Title:
Result Outcome Code
Read Only:true
Maximum Length:230
The outcome code associated with the drop type result. -
ResultSequenceNumber: integer
(int32)
Title:
Result Sequence
The sequence number associated with the drop type result. -
ResultSetCode: string
Title:
Code
Maximum Length:30
The code of a result set that's associated with the drop type. -
ResultSetId: integer
(int64)
Title:
Result Set
The unique identifier for result set that's associated with the drop type. -
ResultSetName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of a result set that's associated with the drop type. -
ResultTextValue: string
Title:
Result
Maximum Length:30
The text value associated with the drop type result.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- DropPeriodAttributeLOV
-
Parameters:
- finder:
ByTypeAndTagFinder%3BTypes%3DORA_DATE%2CORA_DTTM%2CTags%3DDROP
The following properties are defined on the LOV link relation:- Source Attribute: DropPeriodAttributeCode; Target Attribute: PeriodAttributeCode
- Display Attribute: PeriodAttributeName
- finder:
- EnrollmentStatusLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_ENROLLMENT_STATUS%2CLookupCode%3D{EnrollmentStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: EnrollmentStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- dropTypeResults
-
Parameters:
- DropSchemeId:
$request.path.DropSchemeId
- DropSchemeTypeId:
$request.path.DropSchemeTypeId
The drop scheme type results resource maps penalty drop type to penalty result. - DropSchemeId: