• Register

Public Endpoint Domain Path Methods

Resource URI

/domains/public

Items in curly braces represent variables.

Description

Collection of Endpoint fully qualified domain names, request path and HTTP method combinations.

Resource Schema

Property Characteristics
name Type string
Sub-type
Create Rule Required
Update Rule Ignored
Fetch Rule Implicit
Description Name of the Service Definition Endpoint.
method Type string
Sub-type HttpMethod
Create Rule Required
Update Rule Ignored
Fetch Rule Implicit
Description The HttpMethod associated with this Public domains
id Type string
Sub-type
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Service Definition Endpoint identifier.
path Type string
Sub-type
Create Rule Required
Update Rule Ignored
Fetch Rule Implicit
Description Path associated with the Service Definition Endpoint
domain Type string
Sub-type
Create Rule Required
Update Rule Ignored
Fetch Rule Implicit
Description Public domain accociates with the Service Definition Endpoint.
created Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was created.
updated Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was updated.

fetch [GET]

Retrieves collection of all Public Domain Endpoints belonging to the given Area

Parameters

Parameter Required Type Description
methods true object Methods for which we want to retrieve Public Domain Endpoints
domainPrefix true object domainPrefix that matches the retrieved Public Domain Endpoint domain
pathPrefix true object pathPrefix that matches ServiceDefinitionEndpoint path
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0.
indent false boolean When set to true, responses are indented for better readability.

Returns

Success

Array of PublicDomainEndpoints for the Area If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/domains/public' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "524f6a22-a843-486b-984d-88e1f0d738b3",
        "created": "2014-06-01T19:57:44.000+0000",
        "updated": "2013-11-02T20:00:17.000+0000",
        "name": "maecenas",
        "path": "condimentum",
        "domain": "rhoncus mauris enim",
        "method": "pellentesque ultrices phasellus"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/domains/public' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "47989242-68ca-4cad-b2e8-ddd20a74a349",
        "created": "2014-07-05T06:01:43.000+0000",
        "updated": "2014-05-04T01:25:11.000+0000",
        "name": "cras in",
        "path": "ligula in lacus curabitur",
        "domain": "in eleifend quam",
        "method": "non"
    }
]

version 2 as of 4 years ago by jpadre

Docs Navigation