ScheduledMaintenanceEvent

Resource URI

/services/{serviceId}/endpoints/{endpointId}/scheduledMaintenanceEvent

Items in curly braces represent variables.

Description

Resource representing the Scheduled Maintenance Event associated with a given Endpoint.

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 the identified ScheduledMaintenanceEventEndpoint for the Service Definition Endpoint.

Parameters

Parameter Required Type Description
serviceId true string Service identifier.
endpointId true string Endpoint 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

ScheduledMaintenanceEventEndpoint for the Service Endpoint 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/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "848c7964-bfbe-4053-a5c9-adb9db900bcb",
        "startDateTime": "2013-12-18T10:50:38.000+0000",
        "name": "ut",
        "endDateTime": "2014-04-02T04:46:37.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "3cbd2fc1-96b4-4741-b811-c63eba0278d6",
        "startDateTime": "2014-03-12T03:29:41.000+0000",
        "name": "mi nulla ac",
        "endDateTime": "2014-05-07T13:03:33.000+0000"
    }
]

create [POST]

Assigns Cache to a Service Definition.

Parameters

Parameter Required Type Description
serviceId true string Service identifier.
endpointId true string Endpoint identifier.
cache true object Cache object

Returns

Success

ScheduledMaintenanceEventEndpoint for the Service Endpoint 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/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"8691943d-cd30-46d5-b3ed-63eae47b9206","startDateTime":"2014-06-11T07:48:58.000+0000","name":"in hac habitasse","endDateTime":"2013-12-19T06:26:24.000+0000"}

Response

[
    {
        "id": "9c5585f2-6027-4c07-a6c6-f74c4dec7161",
        "startDateTime": "2013-12-28T21:24:20.000+0000",
        "name": "erat quisque erat eros",
        "endDateTime": "2013-08-14T22:44:21.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"911755b9-d03d-45fa-b6d2-47b54b314ba2","startDateTime":"2013-09-22T15:51:51.000+0000","name":"nulla ut","endDateTime":"2013-08-21T14:11:07.000+0000"}

Response

[
    {
        "id": "207f6672-6897-4f96-8f3f-a89f44229c65",
        "startDateTime": "2014-03-02T10:45:02.000+0000",
        "name": "cras",
        "endDateTime": "2013-08-28T23:03:34.000+0000"
    }
]

update [PUT]

Updates the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition.

Parameters

Parameter Required Type Description
serviceId true string Service identifier.
endpointId true string Endpoint identifier.
cache true object Cache object

Returns

Success

ScheduledMaintenanceEventEndpoint for the Service Endpoint 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/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"7203af29-6ac6-4869-970d-fe05de3bae2b","startDateTime":"2013-09-05T09:41:53.000+0000","name":"lacus morbi","endDateTime":"2014-05-07T11:50:35.000+0000"}

Response

[
    {
        "id": "a8b3151e-3155-48a7-9acd-0f7a5cae2cba",
        "startDateTime": "2014-05-02T11:32:15.000+0000",
        "name": "in",
        "endDateTime": "2013-12-23T23:10:22.000+0000"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"9daa6673-481b-4637-992c-f7a054a5f0de","startDateTime":"2013-07-24T09:08:30.000+0000","name":"ante vel","endDateTime":"2014-01-03T19:25:58.000+0000"}

Response

[
    {
        "id": "2486ca1f-c521-4d45-a9e8-22f092dca7e3",
        "startDateTime": "2014-02-15T20:09:01.000+0000",
        "name": "nulla",
        "endDateTime": "2014-01-26T17:10:36.000+0000"
    }
]

delete [DELETE]

Deletes the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition Endpoint.

Parameters

Parameter Required Type Description
serviceId true string Service identifier.
endpointId true string Endpoint identifier.

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/scheduledMaintenanceEvent' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Docs Navigation