EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Schedule Policy

GET /schedule-policies/{id}

Get the details of a schedule policy.

idthe URN of a schedule policy.

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

A SchedulePolicyRestRep reference specifying the data for the schedule policy with the passed policyId.

Field Description Type Notes
<schedule_policy>
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<policy_id> URI
<policy_type> String
<policy_name> String
<schedule_frequency> String
<schedule_repeat> Long
<schedule_time> String
<schedule_day_of_week> String
<schedule_day_of_month> Long
<snapshot_expire_type> String
<snapshot_expire_time> Long
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</schedule_policy>