ScheduledMaintenanceEvents

Resource URI

/scheduledMaintenanceEvents

Items in curly braces represent variables.

Description

Scheduled Maintenance Events represent specific time ranges during which the Mashery Traffic Manager will reject call to specific Endpoints and not pass on to your back-end systems.

Resource Schema

Property	Characteristics
id	Type	string
	Sub-type
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Object identifier.
name	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Name of the Scheduled Maintenance Event. The name can help identify the purpose of the scheduled maintenance event. It is used for administration purposes only.
startDateTime	Type	string
	Sub-type	datetime
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Date and time when the scheduled maintenance event starts.
endDateTime	Type	string
	Sub-type	datetime
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Date and time when the scheduled maintenance event ends.
endpoints	Type	array
	Sub-type	ScheduledMaintenanceEventEndpoint
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Array of Endpoints.

fetch [GET]

Retrieves collection of all Scheduled Maintenance Events objects belonging to the given Area

Parameters

Parameter	Required	Type	Description
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.

Returns

Success

Array of Scheduled Maintenance Events 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/scheduledMaintenanceEvents' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "b4756e4e-d1b7-4626-aa90-24c8a411dc4d",
        "startDateTime": "2014-04-30T10:02:30.000+0000",
        "name": "eleifend donec ut dolor",
        "endDateTime": "2014-03-13T13:58:32.000+0000"
    }
]

Request

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

Response

[
    {
        "id": "afb6a8df-8ed5-4fa7-ac3e-20b4e51df3b3",
        "startDateTime": "2013-08-01T04:32:40.000+0000",
        "name": "integer a nibh",
        "endDateTime": "2013-08-18T12:43:00.000+0000"
    }
]

fetch all [GET]

Retrieves the identified Scheduled Maintenance Event.

Parameters

Parameter	Required	Type	Description
scheduledMaintenanceEventId	true	string	The Scheduled Maintenance Event identifier
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

The identified Scheduled Maintenance Event 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/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "07a3fea1-195a-411e-8feb-a41e2bfefc2c",
        "startDateTime": "2014-04-05T06:01:49.000+0000",
        "name": "volutpat",
        "endDateTime": "2014-04-28T00:26:06.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "41d35a4f-e443-4aaa-b2b9-fe7e4e0c2007",
        "startDateTime": "2014-04-15T03:57:31.000+0000",
        "name": "tincidunt ante vel",
        "endDateTime": "2013-09-20T05:31:54.000+0000"
    }
]

create [POST]

Creates a new Scheduled Maintenance Events in the given Area.

Parameters

Parameter	Required	Type	Description
scheduledMaintenanceEvent	true	object	Scheduled Maintenance Event object

Returns

Success

Scheduled Maintenance Event as created 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/scheduledMaintenanceEvents' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"b6cb36da-6a8c-4e07-904a-75154c2b4ded","startDateTime":"2014-01-11T22:08:23.000+0000","name":"vitae","endDateTime":"2014-01-03T17:36:07.000+0000"}

Response

[
    {
        "id": "19674a52-e747-4a98-b490-29916107f636",
        "startDateTime": "2014-06-02T07:11:31.000+0000",
        "name": "cubilia curae mauris",
        "endDateTime": "2014-01-22T18:12:17.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/scheduledMaintenanceEvents' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"0d045844-fa0c-4b59-adf3-3a81adb757c7","startDateTime":"2013-07-25T18:34:22.000+0000","name":"fringilla rhoncus mauris","endDateTime":"2013-08-31T00:06:48.000+0000"}

Response

[
    {
        "id": "80dc7fed-0076-471f-8728-9a2a6b766e7d",
        "startDateTime": "2014-03-30T23:48:53.000+0000",
        "name": "primis",
        "endDateTime": "2014-04-07T18:26:19.000+0000"
    }
]

update [PUT]

Retrieves the identified Scheduled Maintenance Event.

Parameters

Parameter	Required	Type	Description
scheduledMaintenanceEventId	true	string	The Scheduled Maintenance Event identifier
scheduledMaintenanceEvent	true	object	Scheduled Maintenance Event object

Returns

Success

Scheduled Maintenance Event as persisted 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/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"9f1e66e3-159e-47d1-8f92-4d4c210a6d8b","startDateTime":"2014-06-12T12:03:43.000+0000","name":"id turpis","endDateTime":"2014-03-14T12:39:12.000+0000"}

Response

[
    {
        "id": "9096326c-5066-43b2-a060-c3d65d2c7326",
        "startDateTime": "2014-03-28T04:33:50.000+0000",
        "name": "faucibus",
        "endDateTime": "2013-12-26T15:39:07.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"352148e3-a1c4-46fb-af71-bc27ffc104b8","startDateTime":"2013-08-04T05:38:59.000+0000","name":"lectus in quam fringilla","endDateTime":"2014-05-05T14:21:07.000+0000"}

Response

[
    {
        "id": "a4038cda-86e2-4b86-b38a-d5a0db2dc867",
        "startDateTime": "2013-10-15T04:12:47.000+0000",
        "name": "ut",
        "endDateTime": "2013-11-24T04:02:52.000+0000"
    }
]

delete [DELETE]

Deletes the identified Scheduled Maintenance Event.

Parameters

Parameter	Required	Type	Description
scheduledMaintenanceEventId	true	string	The Scheduled Maintenance Event identifier

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/scheduledMaintenanceEvents/b1785a64-8184-48d1-add1-d2164ebe4a01' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

version 2 as of 4 years ago by jpadre

ScheduledMaintenanceEvents

Resource URI

Description

Resource Schema

fetch [GET]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

fetch all [GET]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

create [POST]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

update [PUT]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

delete [DELETE]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

Docs Navigation