Search operations

get

https://{hostname}/api-definitions/v2/search-operations

Get a filtered list of operations and their endpoints and resources. Use queryType to filter by date ranges or activation statuses. For more complex queries, run Query operations.

Response

Response body

object

Collects data for the operation report.

apiEndPoints

array of objects

required

API endpoints and their data.

apiEndPoints*

object

Collects data about an API endpoint.

apiEndPointHosts

array of strings

required

length ≥ 1

API endpoint hostnames.

A hostname used to publish the API through Akamai.

apiEndPointId

integer

required

Identifies the API endpoint.

apiEndPointName

string

required

length ≥ 1

The name of the API endpoint.

basePath

string

required

length ≥ 1

The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets ({}) to define path parameters (for example, /path/{pathParam}). If you decide to do so, ensure that the value of the apiParameterName member in the corresponding parameter definition matches the name that you specified in the resource path.

caseSensitive

boolean

required

Whether to match on case sensitivity.

link

string

required

length ≥ 1

The location of the navigable resource within this API, for use by API clients.

productionVersion

object

Collects data about the API endpoint's activation status.

stagingVersion

object

Collects data about the API endpoint's activation status.

operations

array of objects

required

Operations and their data.

operations*

object

Collects data for an operation.

apiEndPointId

integer

required

Identifies the API endpoint.

apiResourceId

integer

required

Identifies the API resource.

apiResourceLogicId

integer

required

The unique identifier for the resource across all endpoint versions.

conditions

array of objects | null

Specify the parameter values to match with.

conditions

object

apiParameterId

integer

required

Identifies the API parameter.

value

string | null

The parameter value to match with.

failureConditions

array of objects or null | null

Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation type except SEARCH and ADD_TO_CART.

failureConditions

object | null

Collects data for response conditions.

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* and COOKIE_NAME types.

type

string

enum

required

Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose COOKIE_NAME, HEADER_VALUE, HEADER_VALUE_GREATER_THAN, HEADER_VALUE_LESS_THAN, HEADER_VALUE_BETWEEN, HTTP_STATUS, HEADER_NAME, BODY_XPATH, or BODY_XPATH_JSON.

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

Values to match on. The list length can't exceed 1, unless the type is either HTTP_STATUS, COOKIE_NAME, or HEADER_VALUE_BETWEEN. If the type is HEADER_VALUE_BETWEEN, the length needs to be 2.

A value to match on.

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

link

string

required

length ≥ 1

The location of the navigable resource within this API, for use by API clients.

metadata

object | null

Additional information about the operation.

method

string

enum

required

The HTTP method used in combination with the resource. Choose between HEAD, GET, POST, PUT, DELETE, PATCH, or OPTIONS.

HEAD GET POST PUT DELETE PATCH OPTIONS

multistepGroupId

string

Read-only Identifies the multistep group for the operation.

multistepGroupName

string

Read-only Identifies the multistep group name.

operationId

string

required

Read-only Identifies the operation.

operationName

string

required

length ≥ 1

The name of the operation. Use the same name you gave to the resource if you only specify one operation.

operationParameter

object | null

Collects data for operation parameters defined when the resource was created.

operationPurpose

string

enum

required

The task this operation serves. Choose between LOGIN, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, ACCOUNT_UPDATE, PASSWORD_RESET, PASSWORD_CHANGE, PAYMENT, GIFTCARD_BALANCE_CHECK, LOYALTY_POINTS, SEARCH, ADD_TO_CART, or OTHER.

LOGIN ACCOUNT_VERIFICATION ACCOUNT_CREATION ACCOUNT_UPDATE PASSWORD_RESET PASSWORD_CHANGE PAYMENT GIFTCARD_BALANCE_CHECK LOYALTY_POINTS SEARCH ADD_TO_CART OTHER

originUserIdCondition

object | null

Collects data for response conditions.

successConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART.

successConditions

object | null

Collects data for response conditions.

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* and COOKIE_NAME types.

type

string

enum

required

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

A value to match on.

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

resources

array of objects

required

Resources and their data.

resources*

object

Collects data about a resource.

apiEndPointId

integer

required

Identifies the API endpoint.

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

required

Identifies the API resource.

apiResourceLogicId

integer

required

The unique identifier for the resource across all endpoint versions.

apiResourceMethods

array of objects | null

Method objects that represent HTTP methods the resource may respond to.

apiResourceMethods

object

An HTTP method to which a resource may respond.

apiParameters

array of objects

Parameter objects associated with the method.

apiParameters

object

An HTTP method to which a resource may respond.

apiChildParameters

array of objects

Child JSON members or XML elements for JSON or XML body type parameters.

apiChildParameters

object

A nested API parameter object.

Has additional fields

apiParamLogicId

integer

Read-only The unique identifier for the parameter across all endpoint versions.

apiParameterId

integer

The unique identifier for the parameter.

apiParameterLocation

string

enum

required

The location of the parameter in an HTTP request, either query, header, path, cookie, or body for a JSON or XML body type parameter.

query body header path cookie

apiParameterName

string

required

The name of the parameter. If the corresponding apiParameterLocation is path, ensure that this value matches the parameter name you specified in the resourcePath.

apiParameterNotes

string | null

Optional notes describing the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.

apiParameterRequired

boolean

required

Whether the parameter is needed. If the corresponding apiParameterLocation is path, set this member to true.

apiParameterRestriction

object | null

Specify restrictions and XML representation rules for the parameter.

apiParameterType

string

enum

required

The data type of the parameter, either string, integer, number, boolean for cookies, headers, query string, and path parameters. For request body following types are supported: json, xml, or json/xml for either JSON or XML objects, or urlencoded.

string integer number boolean json/xml json xml urlencoded

apiResourceMethParamId

integer | null

Read-only The unique identifier for the parameter's parent method.

array

boolean

Whether the parameter can express more than one value. This member is only applicable for apiChildParameters that you can specify if the corresponding apiParameterLocation is body and the apiParameterType is json/xml. If you enable this, also define the arrayRestriction member.

arrayItemNullable

boolean | null

Indicates whether items in an array parameter can be null.

nullable

boolean | null

Defaults to false

Indicates whether the parameter value can be null.

pathParamLocationId

integer | null

The index of a segment that includes a path parameter in a resource path. For example, given a path \books\{bookId}, the books segment has index 0, and the path parameter {bookId} has index 1.

response

boolean

Whether the parameter belongs to the response.

apiResourceMethod

string

enum

required

The core HTTP method to which the resource may respond, either GET, PUT, POST, DELETE, HEAD, PATCH, or OPTIONS.

DELETE GET PATCH PUT POST OPTIONS HEAD

apiResourceMethodId

integer

The unique identifier for the resource's allowed method.

apiResourceMethodLogicId

integer

The unique identifier for the resource's method across all endpoint versions.

methodRestrictions

object | null

Collects data for restrictions on the method level.

apiResourceName

string

required

The name of the resource.

createDate

string

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

required

The location of the navigable resource within this API, for use by API clients. Don't include hostnames.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

metadata

object | null

required

Information about the number of methods enabled, methods with assigned operations, and operations.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

length ≥ 1

The resource's path, with the API base path omitted. For example, /login.

updateDate

string

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

validation

object

Contains warnings, errors, or notices determined by validating the match target.

errors

array of objects

required

Read-only Errors.

errors*

object

Contains feedback on validation.

detail

string

The explanation of the error message.

fieldName

string

The name of the field causing the validation problem.

jsonReference

string

The JSON reference to the field in the resource.

operationId

string | null

Identifies the operation.

title

string

required

The title of the error.

type

string

required

The URL for the error type.

notices

array of objects

required

Read-only Notices.

notices*

object

Contains feedback on validation.

detail

string

The explanation of the error message.

fieldName

string

The name of the field causing the validation problem.

jsonReference

string

The JSON reference to the field in the resource.

operationId

string | null

Identifies the operation.

title

string

required

The title of the error.

type

string

required

The URL for the error type.

warnings

array of objects

required

Read-only Warnings.

warnings*

object

Contains feedback on validation.

detail

string

The explanation of the error message.

fieldName

string

The name of the field causing the validation problem.

jsonReference

string

The JSON reference to the field in the resource.

operationId

string | null

Identifies the operation.

title

string

required

The title of the error.

type

string

required

The URL for the error type.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/api-definitions/v2/search-operations \
3
     --header 'accept: application/json'


xxxxxxxxxx
338
}
1
{
2
  "apiEndPoints": [
3
    {
4
      "apiEndPointHosts": [
5
        "www.bot-staging.net",
6
        "www.botman-test1.com",
7
        "www.botman-test.com",
8
        "www.test-login.com"
9
      ],
10
      "apiEndPointId": 503130,
11
      "apiEndPointName": "E2ETest",
12
      "basePath": "/login",
13
      "caseSensitive": true,
14
      "link": "/api-definitions/v2/endpoints/503130/versions/4",
15
      "productionVersion": {
16
        "status": "ACTIVE",
17
        "timestamp": "2019-10-02T16:04:14+0000",
18
        "versionNumber": 4
19
      },
20
      "stagingVersion": {
21
        "status": "ACTIVE",
22
        "timestamp": "2019-10-02T15:59:07+0000",
23
        "versionNumber": 4
24
      }
25
    },
26
    {
27
      "apiEndPointHosts": [
28
        "www.staging-activated.com"
29
      ],
30
      "apiEndPointId": 464125,
31
      "apiEndPointName": "Activated",
32
      "basePath": "/staging",
33
      "caseSensitive": true,
34
      "link": "/api-definitions/v2/endpoints/464125/versions/2",
35
      "productionVersion": {},
36
      "stagingVersion": {
37
        "status": "ACTIVE",
38
        "timestamp": "2020-03-04T15:28:25+0000",
39
        "versionNumber": 2
40
      }
41
    },
42
    {
43
      "apiEndPointHosts": [
44
        "*.vtest.com",
45
        "www.test.com"
46
      ],
47
      "apiEndPointId": 502216,
48
      "apiEndPointName": "Account protections",
49
      "basePath": "/webinline",

200Successful response.