Skip to main content

Get a Custom API Entry using the settings endpoint

GET 

https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/entries/:custom_api_entry_id

Get a Custom API Entry using the settings endpoint

Request

Path Parameters

    custom_api_id stringrequired

    The id of the Custom API.

    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    custom_api_entry_id uuidrequired

    The id of the Custom Entry.

    Example: 7e067539-6f6c-46e1-8c55-940031b36c6a

Responses

OK

Response Headers
    ETag

    A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as etag_id, and is marked as a weak entity tag string. For example: etag: W/"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9

Schema
    data CustomApiEntryAttributesrequired
    iduuidrequired

    The unique identifier for the Custom API Entry

    typestringrequired

    Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.

    links object
    selfuri

    Specifies the URI of the Custom API Entry.

    Example: /extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a
    meta object
    timestamps objectrequired
    updated_atstringrequired

    Specifies the date the entity is created.

    Example: 2017-01-10T11:41:19.244Z
    created_atstringrequired

    Specifies the date the entity is last updated.

    Example: 2017-01-10T11:41:19.244Z
    data_sizeintegerrequired

    Specifies the sum of the size of each value stored for the Custom API Entry in bytes. The total size of a Custom API Entry must not exceed 64KB.

    Default value: 0
    Example: 6
    resource_versioninteger

    A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.

    Default value: 0
    Example: 4
    etag_idstring

    A unique identifier representing the current version of the resource that is a hashed string. When the resource changes, the etag_id will also change.

    Example: 6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b
    property name*any

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/entries/:custom_api_entry_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Parameters
— pathrequired
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.