Environment Calendar API

Get an Environments Calendar Event.

Retrieves a calendar event for an Environment. This call returns a JSON object representing the events in the Environment calendar. Events can be filtered based on the Environment to which the calendar belongs, the Application associated with the event, a date/time range or a combination of all of these.

REST Api Endpoint

HTTP Verb URL
GET /dmadminweb/API/calendar

Parameters

Name Located in Value Required Schema
env query Is the identifier of an Environment. Either its name, its qualified name with its parent Domains included in dot notation (i.e. GLOBAL.Product) or its internal ID. Specifying the Environment filters the results to those events associated with the given Environment. No string
app query Is the identifier of an Application. Either its name, its qualified name with its parent Domains included in dot notation (i.e. GLOBAL.Product) or its internal ID. Specifying the Application filters the results to those events associated with the given Application. No string
starttime query Is a date/time which - if specified - restricts the result to only include events which start on or before the specified time. If endtime is not provided, the API returns all future events. Values can be:
  • YYYY:MM:DD - A date represented by a 4 digit year, a 2 digit month number and a 2 digit day of month.
  • YYYY:MM:DD:hh:mm - A date and time represented by a 4 digit year, a 2 digit month number, a 2 digit day of month and then the hours and minutes.
  • nnnnnnnnnn - An integer number representing the number of seconds since midnight, 1st Jan 1970 (Epoch time)
  • No string
    endtime query Is a date/time which - if specified - restricts the result to only include events which start on or after the specified time. If starttime is not provided, the API only returns events that in the future. Specifying a starttime before the current date/time will return historical events. Values can be:
  • YYYY:MM:DD - A date represented by a 4 digit year, a 2 digit month number and a 2 digit day of month.
  • YYYY:MM:DD:hh:mm - A date and time represented by a 4 digit year, a 2 digit month number, a 2 digit day of month and then the hours and minutes.
  • nnnnnnnnnn - An integer number representing the number of seconds since midnight, 1st Jan 1970 (Epoch time)
  • No string

    Responses for Calendar Event Result

    Name Type Description Required
    success boolean Is true or false depending on the success or failure of the query. If success is false then result is not returned and a text field named “error” is returned instead. No
    result Calendar Event Object (see below) The calendar event. No

    Calendar Event Object

    Name Type Description Required
    allday boolean Is a Boolean indicating whether the event is an “all day” event. No
    application Application Object (see below) Application associated to the event. No
    created Event Timestamp Object (see below) ) Creation time of the event. No
    creator Event Creator Creator of the event. No
    starttime Event Timestamp Object (see below) Start time of the event. No
    endtime Event Timestamp Object (see below) Ending time of the event. No
    deployid integer Is the ID of the deployment (if this is a deployment record), 0 otherwise. No
    desc string Is the Description of the event. No
    environment Event Environment Object (see below) Environment for the even.t No
    id integer Is the internal event id. No
    pending boolean Is a Boolean indicating whether the event is awaiting approval by the environment owner. No
    title string Is the event title. No
    type string Is the event type. No

    Application Object

    Name Type Description Required
    completed string The date/time of the last deployment of this Application into the Environment. No
    deploymentid integer The ID of the last deployment of this Application into the Environment. An ID of 0 indicates that the Application has been manually associated with the environment. No
    exitcode integer The exit code of the last deployment of this Application into the Environment. No
    id integer The internal object ID of the Application Base Version. No
    name string The name of the Application Base Version. No
    predecessorid integer The ID of the previous Application Version. No
    versionid integer The ID of the Application Version. No
    versionname string The name of the Application Version No

    Event Timestamp Object

    datetime and epoc

    Name Type Description Required
    datetime string is the date/time in YYYY:MM:DD:hh:mm format No
    timestamp integer is the date/time in Epoch Time. No

    Event Creator Object

    Is an Object representing the user who created the Event.

    Name Type Description Required
    id integer is the internal User id No
    name string is the name of the User. No

    Environment Event Object

    Is an object representing the Environment for the Event.

    Name Type Description Required
    id integer is the internal environment ID No
    name string is the environment name. No
    Last modified June 15, 2020: markdown tidy (81314aa)