Try this API
Call this method on live data to see the API request and response. Need help with the API Explorer?
Request parameters
You have invalid or missing required parameter values above.
Execute
Orchestly Developers

Locations

Orchestly allows developers to add widgets to different locations based on the context of the extension. Hers's a list of locations that can be used.

Right panel of a job

job.detail.rightpanel

Extensions can be added to the right panel of job's detail page. Here, the widget in the right panel remains static while the left panel with the job details is scrollable.

Attachments to a job

job.detail.attachment.popup

Extensions can be added to the attachment pop-up displayed while adding files to a job. This applies to both Attachment and File fields.

A new tab named 'Other cloud services' will host the extensions.

Bottom panel of a job

job.detail.bottompanel

Extensions can be added to the bottom panel of the job's detail page, displayed while clicking a particular job. Scroll down to the bottom of the page to view the listed extensions. The extension will be added after the Activity stream.

Installation settings in Extensions

extension.settings

Extensions can also be added to the extension installation page, which appears while clicking an extension. Along with the 'General' and 'Connection' tabs, a new custom tab is created to list extensions in this location.

Note: This location can be viewed only after the extension is published. Hence, we recommend you to publish the extension with private visibility to test the location and its functionality.

Comments in a job

job.detail.comment.popup

The comment section of a job can be used to host extensions. Along with the 'Edit' and 'Delete' icon, a custom icon, indicating the extension, is displayed.

During transition tab in blueprints

blueprint.detail.duringtab

Extensions can be added to the During section of a transition in Blueprints. To view this location, navigate to the blueprint's transition and select the During tab.

The extensions configured in this location will later be displayed in 'job.detail.during.popup' location while performing the transition.

Performing transitions in a job

job.detail.during.popup

Extensions can be added to the pop-up which appears while performing a transition in the job. Only after the actions of the extension are completed, the transition can be performed.

New tab in left panel

orchestly.settings

This location refers to the left panel of Settings. Developer extensions can be added as a new tab on the left panel. This new tab will be displayed below the available tabs. On clicking this tab, the extension is displayed in the ensuing page.

New tab in top panel

orchestly.header

Extensions can be added as a new tab at the top panel of Orchestly's landing page. The new tab will be displayed after the 'Jobs' and 'Reports' tabs. On clicking this tab, the extension renders in the ensuing page.

Actions button in job list view

job.list.action

Extensions can be added to the Actions button displayed at the top-right corner in the job list view. The extension name will be listed as an option below the Import and Export options.

Actions button in job

job.details.action

Extensions can be added to the Actions button displayed at the top-right corner of the job details page. The extension name will be listed as an option below 'Move' and 'Delete'

Add job pop-up

job.add

Extensions can be rendered when users attempt to create new jobs in Orchestly. Usually, when a user clicks the Add Job button, a layout form is rendered. However, once an extension is configured in this location, instead of the layout, the extension's iframe is rendered.