Jump to

• Request
• Response

Get an internet account

get

/hcmRestApi/resources/11.13.18.05/internetAccounts/{accountCode}

Request

Path Parameters

• accountCode(required): string
  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: 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.

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 : 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."
        }
    }
}

Links

validateAccount

Operation: /hcmRestApi/resources/11.13.18.05/internetAccounts/{accountCode}/action/validateAccount

Parameters:

• accountCode: $request.path.accountCode

Validates the internet account with the provided credentials.

Back to Top