1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Flow Patterns
  4. Flow Parameters

Get a flow parameter

get

/hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}/child/flowParameters/{FlowParameterId}

Request

Path Parameters
  • 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=
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : flowPatterns-flowParameters-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier from which the flow pattern is inherited.
  • Read Only: true
    Unique identifier from which the flow parameter is inherited.
  • Read Only: true
    Maximum Length: 100
    Code that uniquely identifies the flow parameter.
  • Read Only: true
    Maximum Length: 2000
    Identifier for the default value for a given flow parameter for the corresponding default type, for example an SQL query for default type POST_SQL and SQL, a constant value like CONST, a context value like FTI, LDGID SYSDATE for the default type as BIND_CONTEXT, a flow parameter ID for default type as BIND_FLOW, a flow task parameter ID for default type BIND_FLOW_TASK.
  • Title: Description
    Read Only: true
    Maximum Length: 250
    Description of the flow parameter.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether a parameter should be displayed for a flow pattern. The valid values are Y for Yes, M for Mandatory, and N for No.
  • Read Only: true
    Maximum Length: 30
    Type of a flow parameter. The possible values are UCM for UCM Component, LK for lookups, L choice lists, N for number, LOV for client side list of values, D for date, T for text field and ORA_VALUESET for value sets.
  • Read Only: true
    Maximum Length: 250
    Name of the flow parameter.
  • Read Only: true
    Unique identifier used to retrieve values for a flow parameter.
  • Read Only: true
    Maximum Length: 30
    Country code, such as GB for UK, for the legislative data group that's used to retrieve values for a flow pattern.
  • Read Only: true
    Identifier for the legislative data group associated with the flow pattern.
  • Links
  • Read Only: true
    Maximum Length: 30
    Identifier for the type of defaulting for the parameter. The possible values are, ORA_VALUESET for value sets, BIND_FLOW for using the value from a flow parameter, POST_SQL default for value from a SQL post flow submission, BIND_CONTEXT default context values like FI for flow instance, FTI for flow task instance, LDGID for legislative data group identifiers and SYSDATE for System Date, SQL default for value from a SQL before flow submission and CONST default using a constant value, and BIND_FLOW_TASK for using the value from a flow task parameter.
  • Read Only: true
    Sequence in which parameters are displayed in the flow submission UI.
  • Read Only: true
    Maximum Length: 30
    Option that determines whether a parameter is an input parameter or an output parameter.
Back to Top

Examples

The following example shows how to get a payroll flow parameter by submitting a GET request on the REST resource using cURL. 

curl -i -u "<username>:<password>" -H Content-Type: application/vnd.oracle.adf.resourceitem+json -X GET https://host:port/hcmRestApi/resources/11.13.18.05/flowPatterns/100100075869005/child/flowParameters/100100075871077

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                     
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "FlowParameterId" : 100100075871077,
  "BaseFlowParameterId" : 100100075871077,
  "BaseFlowParameterName" : "EFFECTIVE_DATE",
  "BaseFlowId" : 100100075869005,
  "LegislativeDataGroupId" : null,
  "LegislationCode" : null,
  "Display" : "M",
  "DisplayFormat" : "D",
  "Sequence" : 3,
  "ParameterBasis" : null,
  "BasisValue" : null,
  "Usage" : "INPUT",
  "FlowParameter" : "Effective Date",
  "Description" : "Last date in range of returned records",
  "links" : [ 
        {
           ...}
            ] 
}
Back to Top