Jump to

• Request
• Response

Get an accessNamedRecordList

get

https://{your_site_interface}/opa-hub/api/12.2.40/connections/{connection-serviceName}/accessNamedRecordList

This operation will get an accessNamedRecordList.

Request

Path Parameters

• connection-serviceName(required): string
  The service name.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : accessNamedRecordList

Type: object

Show Source

• expiry: number (double)
  Timestamp (milliseconds since epoch) until data is considered invalid. 0 indicates dynamic data that should not be cached.
• hasMore: boolean
  true if there are more records to be retrieved in a sequence. Use offset parameter to access from a given starting point.
• idField: string
  Field name that identifies records
• nameField: string
  Field name for display of records
• records: array records
  List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.

{
    "type":"object",
    "properties":{
        "expiry":{
            "type":"number",
            "format":"double",
            "description":"Timestamp (milliseconds since epoch) until data is considered invalid. 0 indicates dynamic data that should not be cached."
        },
        "nameField":{
            "type":"string",
            "description":"Field name for display of records"
        },
        "idField":{
            "type":"string",
            "description":"Field name that identifies records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"true if there are more records to be retrieved in a sequence. Use offset parameter to access from a given starting point."
        },
        "records":{
            "type":"array",
            "description":"List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.",
            "items":{
                "$ref":"#/components/schemas/accessNamedRecordListNamedRecordListItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : records

Type: array

List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.

Show Source

• Array of: object accessNamedRecordListNamedRecordListItem
  Additional Properties Allowed: true

{
    "type":"array",
    "description":"List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.",
    "items":{
        "$ref":"#/components/schemas/accessNamedRecordListNamedRecordListItem"
    }
}

Nested Schema : accessNamedRecordListNamedRecordListItem

Type: object

Additional Properties Allowed: true

Back to Top