REST API for Oracle Fusion Cloud HCM

Get all internet accounts

get

/hcmRestApi/resources/11.13.18.05/internetAccounts

Request

Query Parameters

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
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
- PrimaryKey Finds the internet account based on the primary key.
  Finder Variables
  - internetAccountId; integer; Value that uniquely identifies the internet account by the primary key.
- findByAccountCode Finds the internet account based on the account code.
  Finder Variables
  - accountCode; string; Value that uniquely identifies the internet account by account code.
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.
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
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 fields. 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

You can use these queryable attributes to filter this collection resource using the q query parameter:
- accountCode; string; Account code for which the internet account is created.
- accountName; string; Account name for which the internet account is created.
- agentEnabled; string; Indicates if the internet account is enabled for use by AI agents within the application.
- clientId; string; Client identifier used for authentication.
- createdBy; string; User who created the internet account.
- creationDate; string; Date on which the internet account was created.
- description; string; Human-readable description for the internet account.
- family; string; Family name for which the internet account is defined.
- familyMeaning; string; Family name for which the internet account is defined.
- hybridSearchEnabled; string; Indicates whether hybrid search is enabled on the internet account.
- internetAccountId; integer; Unique internet account identifier.
- lastUpdateDate; string; Date and time of the most recent update done on the internet account.
- lastUpdateLogin; string; Login details of the user who did the most recent update on the internet account.
- lastUpdatedBy; string; User who most recently updated the internet account.
- pollInterval; string; Specifies the polling interval for new messages.
- pollIntervalMeaning; string; Description for the pollInterval attribute.
- product; string; Product name for which the internet account is defined.
- providerCode; string; Lookup code representing the internet account provider.
- providerMeaning; string; Description for the providerCode attribute value.
- status; string; Status for the internet account.
- statusMeaning; string; Description for the status attribute value.
- tenantId; string; Tenant or directory identifier for the provider.
- username; string; Name of the user associated with the configured internet account on the provider's platform.
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".

Header Parameters

Metadata-Context: string

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: string

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.

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.

Root Schema : internetAccounts

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

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: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/internetAccounts-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object internetAccounts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/internetAccounts-item-response"
    }
}

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 : internetAccounts-item-response

Type: object

Show Source

accountCode: string

Maximum Length: 30

Account code for which the internet account is created.
accountName: string

Maximum Length: 200

Account name for which the internet account is created.
agentEnabled: string

Maximum Length: 1

Indicates if the internet account is enabled for use by AI agents within the application.
clientId: string

Maximum Length: 150

Client identifier used for authentication.
clientSecret: string

Maximum Length: 80

Client secret used for authentication.
createdBy: string

Read Only: true

Maximum Length: 64

User who created the internet account.
creationDate: string (date-time)

Read Only: true

Date on which the internet account was created.
description: string

Maximum Length: 4000

Human-readable description for the internet account.
family: string

Maximum Length: 80

Family name for which the internet account is defined.
familyMeaning: string

Read Only: true

Maximum Length: 255

Family name for which the internet account is defined.
hybridSearchEnabled: string

Maximum Length: 1

Indicates whether hybrid search is enabled on the internet account.
internetAccountId: integer (int64)

Unique internet account identifier.
lastUpdateDate: string (date-time)

Read Only: true

Date and time of the most recent update done on the internet account.
lastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the internet account.
lastUpdateLogin: string

Read Only: true

Maximum Length: 32

Login details of the user who did the most recent update on the internet account.
links: array Links

Title: Links

The link relations associated with the resource instance.
pollInterval: string

Maximum Length: 30

Specifies the polling interval for new messages.
pollIntervalMeaning: string

Read Only: true

Maximum Length: 255

Description for the pollInterval attribute.
product: string

Maximum Length: 100

Product name for which the internet account is defined.
providerCode: string

Maximum Length: 30

Lookup code representing the internet account provider.
providerMeaning: string

Read Only: true

Maximum Length: 255

Description for the providerCode attribute value.
refreshToken: string

Maximum Length: 150

Refresh token to be used for Google provider accounts.
status: string

Maximum Length: 30

Status for the internet account.
statusMeaning: string

Read Only: true

Maximum Length: 255

Description for the status attribute value.
tenantId: string

Maximum Length: 36

Tenant or directory identifier for the provider.
username: string

Maximum Length: 254

Name of the user associated with the configured internet account on the provider's platform.

{
    "type":"object",
    "properties":{
        "accountCode":{
            "maxLength":30,
            "type":"string",
            "description":"Account code for which the internet account is created.",
            "nullable":false,
            "x-queryable":true
        },
        "accountName":{
            "maxLength":200,
            "type":"string",
            "description":"Account name for which the internet account is created.",
            "nullable":true,
            "x-queryable":true
        },
        "agentEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the internet account is enabled for use by AI agents within the application.",
            "nullable":true,
            "x-queryable":true
        },
        "clientId":{
            "maxLength":150,
            "type":"string",
            "description":"Client identifier used for authentication.",
            "nullable":true,
            "x-queryable":true
        },
        "clientSecret":{
            "maxLength":80,
            "type":"string",
            "description":"Client secret used for authentication.",
            "nullable":true,
            "x-queryable":false
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the internet account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date on which the internet account was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "description":{
            "maxLength":4000,
            "type":"string",
            "description":"Human-readable description for the internet account.",
            "nullable":true,
            "x-queryable":true
        },
        "family":{
            "maxLength":80,
            "type":"string",
            "description":"Family name for which the internet account is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "familyMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Family name for which the internet account is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "hybridSearchEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether hybrid search is enabled on the internet account.",
            "nullable":true,
            "x-queryable":true
        },
        "internetAccountId":{
            "type":"integer",
            "description":"Unique internet account identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"Date and time of the most recent update done on the internet account.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login details of the user who did the most recent update on the internet account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the internet account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "pollInterval":{
            "maxLength":30,
            "type":"string",
            "description":"Specifies the polling interval for new messages.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "pollIntervalMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the pollInterval attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "product":{
            "maxLength":100,
            "type":"string",
            "description":"Product name for which the internet account is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "providerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup code representing the internet account provider.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "providerMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the providerCode attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "refreshToken":{
            "maxLength":150,
            "type":"string",
            "description":"Refresh token to be used for Google provider accounts.",
            "nullable":true,
            "x-queryable":false
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the internet account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "statusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the status attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "tenantId":{
            "maxLength":36,
            "type":"string",
            "description":"Tenant or directory identifier for the provider.",
            "nullable":true,
            "x-queryable":true
        },
        "username":{
            "maxLength":254,
            "type":"string",
            "description":"Name of the user associated with the configured internet account on the provider's platform.",
            "nullable":false,
            "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."
        }
    }
}