System Endpoint Domain Paths

Resource URI

/domains/system

Items in curly braces represent variables.

Description

Collection of Endpoint fully qualified domain name and path 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.
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 target
domain	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Domain associated with the target.
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 System Domain Endpoints belonging to the given Area

Parameters

Parameter	Required	Type	Description
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 SystemDomainEndpoints 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/system' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "5082b381-0ef9-4970-994b-e467f4d03142",
        "created": "2013-12-17T11:37:01.000+0000",
        "updated": "2014-01-30T15:57:39.000+0000",
        "name": "elementum eu interdum",
        "path": "quis orci nullam molestie",
        "domain": "luctus et"
    }
]

Request

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

Response

[
    {
        "id": "bcb97f3c-5531-4ccb-b7a7-bbde3e84457d",
        "created": "2013-12-19T20:22:07.000+0000",
        "updated": "2013-11-11T01:44:12.000+0000",
        "name": "a pede posuere",
        "path": "nisl",
        "domain": "vestibulum quam sapien"
    }
]