Jump to

• Request
• Response
• Examples

Get a flow pattern

get

/hcmRestApi/resources/11.13.18.05/flowPatternsLOV/{FlowId}

Request

Path Parameters

• FlowId(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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : flowPatternsLOV-item-response

Type: object

Show Source

• BaseFlowId: integer (int64)
  Read Only: true

  Unique identifier from which the flow pattern is inherited.
• BaseFlowName: string
  Read Only: true

  Maximum Length: 100

  Code that uniquely identifies the flow pattern.
• DefaultFlowFlag: boolean
  Title: Flow Submission Type

  Read Only: true

  Maximum Length: 1

  Indicates whether a flow is a task flow or a standalone process and whether it's active or inactive. The possible values are H, D, Y, and N.
• Description: string
  Read Only: true

  Maximum Length: 250

  Description of the flow pattern.
• FlowId: integer (int64)
  Read Only: true

  Uniquer identifier used to retrieve the flow pattern.
• FlowName: string
  Title: Flow Pattern

  Read Only: true

  Maximum Length: 250

  Name of the flow pattern.
• Lc: string
  Value of the legislation code that assists the search operation performed using the intent variable.
• LDGRqdFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether a legislative data group identifier must be provided when creating a flow instance using the flow pattern. The possible values are Y, B, and N.
• LegislationCode: string
  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.
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Identifier for the legislative data group associated with the flow pattern.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FlowId":{
            "type":"integer",
            "description":"Uniquer identifier used to retrieve the flow pattern.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Identifier for the legislative data group associated with the flow pattern.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LDGRqdFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a legislative data group identifier must be provided when creating a flow instance using the flow pattern. The possible values are Y, B, and N.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Country code, such as GB for UK, for the legislative data group that's used to retrieve values for a flow pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":250,
            "type":"string",
            "description":"Description of the flow pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowName":{
            "title":"Flow Pattern",
            "maxLength":250,
            "type":"string",
            "description":"Name of the flow pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultFlowFlag":{
            "title":"Flow Submission Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a flow is a task flow or a standalone process and whether it's active or inactive. The possible values are H, D, Y, and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Lc":{
            "type":"string",
            "description":"Value of the legislation code that assists the search operation performed using the intent variable.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BaseFlowId":{
            "type":"integer",
            "description":"Unique identifier from which the flow pattern is inherited.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseFlowName":{
            "maxLength":100,
            "type":"string",
            "description":"Code that uniquely identifies the flow pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example shows how to retrieve a flow pattern that matches a specified word. You can submit a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H Effective-Of:RangeStartDate=2010-10-12 -X GET https://<hostname>:<portno>/hcmRestApi/resources/11.13.18.05/flowPatternsLOV?fields=FlowId,LegislativeDataGroupId,FlowName&finder=findByWord;Intent=SEARCH,SearchTerms=Cal,FilterAttributes=FlowName&onlyData=true"

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.

{
  "items" : [ {
    "FlowId" : 100100075869005,
    "BaseFlowId" : 100100075869005,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "123",
    "FlowName" : "123",
    "Description" : null,
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 300100122495697,
    "BaseFlowId" : 300100122495697,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : 300100058923133,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "AE REPORTS GOV SEC FLOW",
    "FlowName" : "AE Reports Gov Sec Flow",
    "Description" : "AE Reports Gov Sec Flow",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 300100121379642,
    "BaseFlowId" : 300100121379642,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : 300100058923133,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "AE LEG REPORTS",
    "FlowName" : "AE leg Reports",
    "Description" : "Dont use this flow",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 300100122495083,
    "BaseFlowId" : 300100122495083,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : 300100058923133,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "AE LEG REPORTS GOV FLOW",
    "FlowName" : "AE leg Reports Gov Flow",
    "Description" : "AE leg Reports Gov Flow-----",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100100055324619,
    "BaseFlowId" : 100100055324619,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "ANC_DEV_ABS_PLAN_ENTRY_EXT",
    "FlowName" : "ANC_DEV_ABS_PLAN_ENTRY_EXT",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100100055315495,
    "BaseFlowId" : 100100055315495,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "ANC_DEV_PER_ABS_DTL_EXT",
    "FlowName" : "ANC_DEV_PER_ABS_DTL_EXT",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100100054948238,
    "BaseFlowId" : 100100054948238,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "ANC_DEV_PER_ABS_EXT",
    "FlowName" : "ANC_DEV_PER_ABS_EXT",
    "Description" : null,
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100100055316495,
    "BaseFlowId" : 100100055316495,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "ANC_DEV_PER_ACC_ENTRY_EXT",
    "FlowName" : "ANC_DEV_PER_ACC_ENTRY_EXT",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100100054963479,
    "BaseFlowId" : 100100054963479,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "ANC_DEV_PER_ACC_EXT",
    "FlowName" : "ANC_DEV_PER_ACC_EXT",
    "Description" : null,
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 300100186314850,
    "BaseFlowId" : 300100186314850,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "AN_OFFCYCLE",
    "FlowName" : "AN_OFFCYCLE",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 300100186314801,
    "BaseFlowId" : 300100186314801,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "AN_ONCYCLE",
    "FlowName" : "AN_ONCYCLE",
    "Description" : null,
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100100128179883,
    "BaseFlowId" : 100100128179883,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "AN_PAYROLL Activity Report",
    "FlowName" : "AN_PAYROLL Activity Report",
    "Description" : "Global Payroll Activity Report",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100000021552081,
    "BaseFlowId" : 100000021552081,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "COST_ADJUSTMENT",
    "FlowName" : "Adjust Cost for a Person",
    "Description" : "Correct original costing by reallocating to a different account or changing the amounts costed to individual accounts.",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100000021552073,
    "BaseFlowId" : 100000021552073,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "BALANCE_ADJUSTMENT",
    "FlowName" : "Adjust Individual Balances",
    "Description" : "Adjust one or more balance values for an employee, such as a refund or adjustment of withholdings or liabilities.",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100000021552076,
    "BaseFlowId" : 100000021552076,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "BATCH_BALANCE_ADJUSTMENT",
    "FlowName" : "Adjust Multiple Balances",
    "Description" : "Submit a process to create adjustment entries for a batch of balances for one or more workers, such as tax refunds or adjustments to wages subject to withholding.",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100000021552072,
    "BaseFlowId" : 100000021552072,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "ADJUST_RUN_BALANCE_DATE",
    "FlowName" : "Adjust Run Balance Dates",
    "Description" : "Adjust the balance start date of all valid run balances. Recalculate and validate balances by generating the run balances.",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 300100089147013,
    "BaseFlowId" : 300100089147013,
    "LegislationCode" : "US",
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "US_EOY_ACA_ARCHIVE",
    "FlowName" : "Archive End-of-Year ACA Information",
    "Description" : "This is US End of Year ACA Archive definition.",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100000021552089,
    "BaseFlowId" : 100000021552089,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "END_OF_YEAR_ARCHIVER",
    "FlowName" : "Archive End-of-Year Payroll Results",
    "Description" : "Submit a process to archive the end-of-year payroll results for use for reporting purposes.",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100000021552105,
    "BaseFlowId" : 100000021552105,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "PAYSLIP_ARCHIVER",
    "FlowName" : "Archive Periodic Payroll Results",
    "Description" : "Submit a process to archive the payroll results, which are used for reporting purposes.",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100100126908367,
    "BaseFlowId" : 100100126908367,
    "LegislationCode" : "US",
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "Assign Control Number for Puerto Rico Employees",
    "FlowName" : "Assign Control Number for Puerto Rico Employees",
    "Description" : "Assign Control Number for Puerto Rico Employees",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 300100060008958,
    "BaseFlowId" : 300100060008958,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : false,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "300100060008958BV_LBF_TB",
    "FlowName" : "BV_LBF_TB",
    "Description" : "Linking LoadBatchFile and TransferBatch",
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 300100060854045,
    "BaseFlowId" : 300100060854045,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "300100060854045BV_Rollback Batch",
    "FlowName" : "BV_Rollback Batch",
    "Description" : "To Rollback the Transferred Batch",
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 300100186657711,
    "BaseFlowId" : 300100186657711,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : 300100025776039,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : true,
    "BaseFlowName" : "BW_PAYROLL ACTIVITY REPORT ",
    "FlowName" : "BW_PAYROLL Activity Report ",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  }, {
    "FlowId" : 100100059561170,
    "BaseFlowId" : 100100059561170,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "Basic_Coverage_All_Record_Types",
    "FlowName" : "Basic_Coverage_All_Record_Types",
    "Description" : null,
    "Lc" : null,
    "links" : [  ]
  }, {
    "FlowId" : 100100059545555,
    "BaseFlowId" : 100100059545555,
    "LegislationCode" : null,
    "LegislativeDataGroupId" : null,
    "DefaultFlowFlag" : true,
    "LDGRqdFlag" : false,
    "BaseFlowName" : "Basic_Coverage_CDRM",
    "FlowName" : "Basic_Coverage_CDRM",
    "Description" : null,
    "Lc" : null,
    "links" : [ ]
  } ],
  "count" : 25,
  "hasMore" : true,
  "limit" : 25,
  "offset" : 0,
  "links" : [  ]
}

Back to Top