Skip to main content
System StatusContact Support
VersionOne Community

Continuum REST API/Response Objects

Overview

The Continuum REST API has many functions, most of which return CSK Objects, such as a Task. The API supports three output formats - text, json, and xml. This article defines what sort of object each function returns.

Some API functions return a _list_ of object. In this case, the output will be a JSON array of the object, or an XML array, depending on the specified output format.

AUTOMATE

Asset

JSON

{
    "Address": "",
    "Credentials": "",
    "ID": "",
    "Name": "",
    "SharedOrLocal": "",
    "Status": "",
    "Tags": []
}

XML

<Asset>
    <Address />
    <Credentials />
    <ID />
    <Name />
    <SharedOrLocal />
    <Status />
    <Tags />
</Asset>

Text

The text response will include the following properties:

  • Name
  • Status
  • Address
  • SharedOrLocal
  • Credentials

Cloud

JSON

{
    "APIProtocol": "",
    "APIUrl": "",
    "DefaultAccount": "",
    "ID": "",
    "Name": "",
    "Provider": ""
}

XML

<Cloud>
    <APIProtocol />
    <APIUrl />
    <DefaultAccount />
    <ID />
    <Name />
    <Provider />
</Cloud>

Text

The text response will include the following properties:

  • ID
  • Name
  • Provider
  • APIUrl
  • APIProtocol
  • DefaultAccount

Cloud Account

JSON

{
    "AccountNumber": "",
    "DefaultCloud": "",
    "ID": "",
    "IsDefault": "",
    "LoginID": "",
    "Name": "",
    "Provider": ""
}

XML

<CloudAccount>
    <AccountNumber />
    <DefaultCloud />
    <ID />
    <Name />
    <IsDefault />
    <LoginID />
    <Provider />
</Cloud>

Text

The text response will include the following properties:

  • ID
  • Name
  • Provider
  • AccountNumber
  • LoginID
  • DefaultCloud

Cloud KeyPair

JSON

{
    "HasPassphrase": "",
    "HasPrivateKey": "",
    "ID": "",
    "Name": ""
}

XML

<KeyPair>
    <HasPassphrase />
    <HasPrivateKey />
    <ID />
    <Name />
</KeyPair>

Text

The text response will include the following properties:

  • Name

Credential

JSON

{
    "Description": "",
    "Domain": "",
    "ID": "",
    "Name": "",
    "Type": "",
    "Username": ""
}

XML

<Credential>
    <Description />
    <Domain />
    <ID />
    <Name />
    <Type />
    <Username />
</Credential>

Text

The text response will include the following properties:

  • Name
  • Username
  • Domain
  • Description

Datastore Document

A Datastore Document is a document with a completely customizable schema. Datastore Documents are stored in MongoDB, therefore are JSON in their native format.

If the xml output format is specified, the API will make an attempt to convert the document to XML.

The text format makes no conversion attempt - text also returns a JSON representation.

Execution Plan

JSON

{
    "ActionID": null,
    "PlanID": 0,
    "RunOn": "",
    "ScheduleID": "",
    "Source": ""
}

XML

<Plan>
    <ActionID />
    <PlanID />
    <RunOn />
    <ScheduleID />
    <Source />
</Plan>

Text

The text response will include the following properties:

  • PlanID
  • RunOn
  • Source
  • ScheduleID

Task

There are several ways a Task Object can be returned - basic and complete. Some functions (that only need a list of Tasks) will return the basic properties, and others will return the more complete object.

JSON

Basic Response

{
    "Code": "",
    "Description": "",
    "ID": "",
    "Name": "",
    "OriginalTaskID": "",
    "Status": "",
    "Tags": null,
    "Version": 1.0,
    "Versions": 1
}

Additional Details in Complete Response

{
    "ConcurrentInstances": "",
    "IsDefaultVersion": true,
    "NextMajorVersion": ",
    "NextMinorVersion": "",
    "NumberOfApprovedVersions": 0,
    "OriginalTaskID": "",
    "QueueDepth": ""
}

XML

<Task>
    <Code />
    <ConcurrentInstances />
    <ID />
    <Description />
    <IsDefaultVersion />
    <Name />
    <NextMajorVersion />
    <NextMinorVersion />
    <NumberOfApprovedVersions />
    <OriginalTaskID />
    <QueueDepth />
    <Status />
    <Version />
</Task>

Text

The text response will include the following properties:

  • Code
  • Name
  • Version
  • Description
  • Status
  • IsDefaultVersion

Task Instance

JSON

{
    "Instance": "",
    "account_id": "",
    "account_name": "",
    "allow_cancel": "",
    "asset_id": "",
    "asset_name": "",
    "ce_node": "",
    "cloud_id": "",
    "cloud_name": "",
    "completed_dt": "",
    "debug_level": 20,
    "options": {},
    "pid": "",
    "started_dt": "",
    "submitted_by": "",
    "submitted_by_instance": "",
    "submitted_dt": "",
    "summary": [],
    "task_id": "",
    "task_instance": "",
    "task_name": "",
    "task_name_label": "",
    "task_status": ""
}

If a Task is doing work for another Continuum application, the options property will contain additional useful information.

For example, in this case the Task Instance was doing work for a Deployment Monitor:

"options": {
    "DeploymentID": "6a80129c-76f1-11e3-955e-c8bcc89c1491",
    "InstanceID": "6fc13b14-76f1-11e3-aa59-c8bcc89c1491",
    "ServiceID": "6a84a62b-76f1-11e3-a42a-c8bcc89c1491",
    "State": "Running",
    "Type": "Monitor"
},

XML

<TaskInstance>
    <task_name_label />
    <pid />
    <debug_level />
    <account_name />
    <asset_id />
    <submitted_by />
    <cloud_id />
    <ce_node />
    <submitted_dt />
    <submitted_by_instance />
    <account_id />
    <completed_dt />
    <asset_name />
    <cloud_name />
    <task_instance />
    <task_id />
    <Instance />
    <started_dt />
    <allow_cancel />
    <task_name />
    <task_status />
    <options />
</TaskInstance>

Text

The text response will include the following properties:

  • task_instance
  • task_status
  • task_name_label
  • submitted_dt
  • completed_dt

Task Log

A Task Log will be a list of individual log entry items. The complete Task Log contains additional information beyond the actual items.

JSON

Task Log Object

{
    "instance": "",
    "log_rows": [ "A list of 'log_row' Objects" ],
    "numrows": 0,
    "summary_rows": null,
    "task_id": "",
    "task_status": ""
}

log_row Object

{
        "codeblock_name": "",
        "command_text": "",
        "connection_name": "",
        "entered_dt": "",
        "function_label": "",
        "function_name": "",
        "log": "",
        "step_id": "",
        "step_order": 1,
        "task_id": "",
        "task_instance": 0,
        "variable_name": "",
        "variable_value": ""
    }

XML

At this time, the XML response does not contain additional details - it is simply an array of log_row Objects.

log_row Object

<row>
    <codeblock_name />
    <command_text />
    <connection_name />
    <entered_dt />
    <function_label />
    <log />
    <step_id />
    <step_order />
    <task_id />
    <task_instance />
    <variable_name />
    <variable_value />
</Process>

Text

The text response will include the following properties:

  • codeblock_name

  • step_order

  • function_name

  • log

Task Schedule

JSON

{
    "Days": [],
    "DaysOrWeekdays": "",
    "Debug": 50,
    "Description": "",
    "Hours": [],
    "Label": "",
    "Minutes": [],
    "Months": [],
    "Parameters": "",
    "ScheduleID": "",
    "Task": ""
}

XML

<Schedule>
    <Days />
    <DaysOrWeekdays />
    <Debug />
    <Description />
    <Hours />
    <Label />
    <Minutes />
    <Months />
    <Parameters />
    <ScheduleID />
    <Task />
</Schedule>

Text

The text response will include the following properties:

  • ScheduleID
  • Label
  • Description

FLOW

Pipeline Definition

JSON

{
    "_id": "",
    "name": "",
    "project": "",
    "description": "",
    "phases": []
}

XML

<definition>
    <_id />
    <name />
    <project />
    <description />
    <phases />
</definition>

Text

The text response will include the following properties:

  • _id
  • name

Phase

JSON

{
    "_id": "",
    "name": "",
    "description": "",
    "stages": []
}

XML

<phase>
    <_id />
    <name />
    <description />
    <stages />
</phase>

Text

The text response will include the following properties:

  • _id
  • name

Stage

JSON

{
    "_id": "",
    "name": "",
    "description": "",
    "ingate": {},
    "outgate": {},
    "steps": []
}

XML

<stage>
    <_id />
    <name />
    <description />
    <ingate />
    <outgate />
    <steps />
</stage>

Text

The text response will include the following properties:

  • _id
  • name

Project

JSON

{
    "_id": "",
    "name": ""
    "create_dt": "",
    "status": ""
}

XML

<project>
    <_id />
    <name />
    <create_dt />
    <status />
</stage>

Text

The text response will include the following properties:

  • _id
  • name

Pipeline Instance

JSON

{
    "_id": "",
    "name": ""
    "project": "",
    "story": "",
    "pipeline_id": "",
    "pipeline_name": "",
    "status": ""
}

XML

<pipelineinst>
    <_id />
    <name />
    <project />
    <story />
    <pipeline_id />
    <pipeline_name />
    <status />
</pipelineinst>

Text

The text response will include the following properties:

  • _id
  • name

Pipeline Instance

JSON

{
    "_id": "",
    "name": "",
    "project": "",
    "story": "",
    "pipeline_id": "",
    "pipeline_name": "",
    "pi_summary_id": "",
    "data": {},
    "ingate": {},
    "outgate": {},
    "phases": [],
    "start_dt": "",
    "end_dt": "",
    "status": ""
}

XML

<pipelineinstance>
    <_id />
    <name />
    <project />
    <story />
    <pipeline_id />
    <pipeline_name />
    <pi_summary_id />
    <data />
    <ingate />
    <outgate />
    <phases />
    <start_dt />
    <end_dt />
    <status />
 </pipelineinstance>

Text

The text response will include the following properties:

  • _id
  • name

DEPLOY

Action Instance

JSON

{
    "ActionID": "",
    "ActionName": "",
    "CompletedDate": "",
    "DeploymentID": "",
    "ServiceID": "",
    "ServiceInstanceID": "",
    "ServiceInstanceName": "",
    "ServiceName": "",
    "StartedBy": "",
    "Status": "",
    "SubmittedDate": "",
    "TaskInstance": 0
}

XML

<Instance>
    <Status />
    <ActionName />
    <ServiceInstanceName />
    <ServiceName />
    <TaskInstance />
    <SubmittedDate />
    <DeploymentID />
    <ServiceID />
    <ActionID />
    <CompletedDate />
    <StartedBy />
    <ServiceInstanceID />
</Instance>

Text

The text response will include the following properties:

  • ActionName
  • ServiceName
  • ServiceInstanceName
  • TaskInstance
  • Status
  • StartedBy
  • SubmittedDate
  • CompletedDate

Application Template

JSON

{
    "Available": 0,
    "Categories": null,
    "Description": "",
    "ID": "",
    "Icon": "",
    "Name": "",
    "ServiceCount": 0,
    "Text": "",
    "Version": ""
}

XML

<DeploymentTemplate>
    <Available />
    <Description />
    <Text />
    <ServiceCount />
    <Version />
    <Icon />
    <ID />
    <Categories />
    <Name />
</DeploymentTemplate>

Text

The text response will include the following properties:

  • ID
  • Name
  • Version
  • Available
  • Description

Datastore Document

A Datastore Document is a document with a completely customizable schema. Datastore Documents are stored in MongoDB, therefore are JSON in their native format.

If the xml output format is specified, the API will make an attempt to convert the document to XML.

The text format makes no conversion attempt - text also returns a JSON representation.

Deployment

JSON

{
    "Archived": "",
    "AutomationStatus": "",
    "Categories": "[]",
    "Created": "",
    "Description": "",
    "Expires": "",
    "Groups": [],
    "Health": "",
    "ID": "",
    "InstanceCount": 0,
    "Name": "",
    "Options": {},
    "OwnerName": "",
    "RunState": "",
    "ServiceCount": -,
    "Tags": [],
    "Template": "",
    "TemplateID": "",
    "Version": ""
}

XML

<Deployment>
    <ServiceCount />
    <Archived />
    <AutomationStatus />
    <Name />
    <Created />
    <RunState />
    <Expires />
    <Options />
    <Version />
    <Health />
    <OwnerName />
    <Template />
    <TemplateID />
    <Groups />
    <Tags />
    <InstanceCount />
    <ID />
    <Categories />
    <Description />
</Deployment>

Text

The text response will include the following properties:

  • Name
  • RunState
  • Health
  • AutomationStatus
  • ServiceCount
  • InstanceCount
  • Description

Deployment Sequence

A Sequence is a complicated hierarchical object, containing multiple Steps, which each can contain multiple Services, which in turn contain a reference to a Task object.

JSON

{
    "Description": "",
    "ID": "",
    "Icon": "",
    "Name": "",
    "Options": {},
    "Prompts": [],
    "Services": ["A distinct list of Service Objects managed by this Sequence."],
    "Steps": ["A list of Steps on the Sequence, each containing one or more Service Objects and an automation Task."]
}

XML

<Sequence>
    <Description>
    <ID>
    <Icon>
    <Name>
    <Options>
    <Prompts>
    <Services>A distinct list of Service Objects managed by this Sequence</Services>
    <Steps>A list of Steps on the Sequence, each containing one or more Service Objects and an automation Task.</Steps>
</Sequence>

Text

A Deployment Sequence is a special case for the text output format. Since a Sequence is a hierarchical object, the test output represents that structure using indentations and other visual markers. For example:

Start
* Step 1
---- Database
        Task: start_database
        DesiredState: Init
        RunLevel: 0
---- Process Scheduler
        Task: start_scheduler
        DesiredState: Init
        RunLevel: 0
* Step 2
---- App Server
        Task: start_appsrv
        DesiredState: Init
---- Database
        Task: init_database
        DesiredState: Init
        RunLevel: 1

Deployment Service

JSON

{
    "AutomationStatus": "",
    "Cloud": {},
    "CloudAccount": {},
    "Datastore": {},
    "Description": "",
    "DocumentID": "",
    "Health": "",
    "ID": "",
    "Instances": 0
    "Name": "",
    "Options": {}
}

XML

<Service>
    <Description />
    <Options />
    <Instances />
    <AutomationStatus />
    <Health />
    <DocumentID />
    <Datastore />
    <CloudAccount />
    <ID />
    <Cloud />
    <Name />
</Service>

Text

The text response will include the following properties:

  • Name

Deployment Service Instance

JSON

{
    "Address": "",
    "AutomationStatus": "",
    "Cloud": {},
    "CloudAccount": {},
    "CurrentState": "",
    "Datastore": {},
    "DeploymentID": "",
    "Description": "",
    "DocumentID": "",
    "Health": "",
    "HostName": "",
    "ID": "",
    "InstanceID": "",
    "Label": "",
    "Name": "",
    "Options": {},
    "RunLevel": 0
}

XML

<Instance>
    <Options />
    <Description />
    <InstanceID />
    <HostName />
    <DocumentID />
    <RunLevel />
    <Label />
    <DeploymentID />
    <AutomationStatus />
    <Health />
    <Cloud />
    <Address />
    <Datastore />
    <CloudAccount />
    <ID />
    <CurrentState />
    <Name />
</Instance>

Text

The text response will include the following properties:

  • ServiceName
  • Label
  • HostName
  • Address

Monitor Instance

JSON

{
    "ActionID": "",
    "ActionName": "",
    "CompletedDate": "",
    "DeploymentID": "",
    "ServiceID": "",
    "ServiceInstanceID": "",
    "ServiceInstanceName": "",
    "ServiceName": "",
    "StartedBy": "",
    "Status": "",
    "SubmittedDate": "",
    "TaskInstance": 0,
    "TaskName": "",
    "TaskVersion": ""
}

XML

<Instance>
    <Status />
    <ServiceInstanceName />
    <ServiceName />
    <TaskInstance />
    <TaskName />
    <TaskVersion />
    <SubmittedDate />
    <DeploymentID />
    <ServiceID />
    <CompletedDate />
    <ServiceInstanceID />
</Instance>

Text

The text response will include the following properties:

  • TaskName
  • TaskVersion
  • ServiceName
  • ServiceInstanceName
  • TaskInstance
  • Status
  • SubmittedDate
  • CompletedDate

Sequence Instance

JSON

{
    "CompletedDate": "",
    "DeploymentID": "",
    "Instance": 0,
    "SequenceID": "",
    "SequenceName": "",
    "StartedBy": "",
    "Status": "",
    "SubmittedDate": ""
}

XML

<Instance>
    <Status />
    <Instance />
    <SequenceID />
    <SequenceName />
    <SubmittedDate />
    <CompletedDate />
    <StartedBy />
    <DeploymentID />
</Instance>

Text

The text response will include the following properties:

  • Instance
  • SequenceName
  • Status
  • StartedBy
  • SubmittedDate
  • CompletedDate

ADMIN

Settings

The Settings object is a complete description of the current Continuum system configuration. json and xml will return the complete configuration in the speficied output format. text format is a special case, and it will format the settings into a readable format.

Text

Security
    AllowLogin : True
    PassMaxLength : 15
    PassMinLength : 6
    PasswordHistory : 0
    AutoLockReset : True
    PassComplexity : False
    PassMaxAttempts : 99
    PassRequireInitialChange : False

Poller
    LoopDelay : 3
    Enabled : True
    MaxProcesses : 4

User

 

A User object contains secure information such as passwords. This secure information is never included in a User object.

JSON

{
    "AuthenticationType": "",
    "Email": "",
    "FullName": "",
    "LastLoginDT": "",
    "LoginID": "",
    "Role": "",
    "Status": ""
}

XML

<User>
    <AuthenticationType />
    <Email />
    <FullName />
    <LastLoginDT />
    <LoginID />
    <Role />
    <Status />
</User>

Text

The text response will include the following properties:

  • FullName
  • Role
  • Status
  • AuthenticationType
  • Email

Log Entry

To conserve space, log entries are stored with numeric codes for ObjectType. Additionally, a log entry will have an Action and LogType property.

ObjectType:

NA = 0
User = 1
Asset = 2
Task = 3
Schedule = 4
Tag = 7
Image = 8
MessageTemplate = 18
Parameter = 34
Credential = 35
Domain = 36
CloudAccount = 40
Cloud = 41
CloudKeyPair = 45
CanvasItem = 50
Deployment = 70
DeploymentTemplate = 71
DeploymentService = 72
DeploymentSequence = 73

LogTypes:

  • Object
  • Security
  • Usage
  • Other

Actions:

  • UserLogin
  • UserLogout
  • UserLoginAttempt
  • UserPasswordChange
  • UserSessionDrop
  • SystemLicenseException
  • ObjectAdd
  • ObjectModify
  • ObjectDelete
  • ObjectView
  • ObjectCopy
  • PageView
  • ReportView
  • APIInterface
  • Other
  • ConfigChange

JSON

{
    "Action": "",
    "Log": "",
    "LogDate": "",
    "LogType": "",
    "ObjectID": "",
    "ObjectType": 0,
    "User": ""
}

XML

<item>
    <Action />
    <Log />
    <LogDate />
    <LogType />
    <ObjectID />
    <ObjectType />
    <User />
</item>

Text

The text response will include the following properties:

  • User
  • Action
  • LogDate
  • Log

Process

JSON

{
    "Component": "",
    "Enabled": "",
    "Heartbeat": "",
    "Instance": "",
    "LoadValue": null,
    "MinutesIdle": 0,
    "hostname": "",
    "platform": ""
}

XML

<Process>
    <Component />
    <Enabled />
    <Heartbeat />
    <Instance />
    <LoadValue />
    <MinutesIdle />
    <hostname />
    <platform />
</Process>

Text

The text response will include the following properties:

  • Instance
  • Component
  • Heartbeat
  • Enabled
  • LoadValue
  • MinutesIdle

Tag

JSON

{
    "in_use": 5,
    "tag_desc": "Manage the Peoplesoft application.",
    "tag_name": "PeoplesoftAdmin"
}

XML

<Tag>
    <in_use />
    <tag_desc />
    <tag_name />
</Tag>

Text

The text response will include the following properties:

  • in_use
  • tag_desc
  • tag_name
  • Was this article helpful?