{"componentChunkName":"component---src-templates-default-template-tsx","path":"/documentation/integration/Capabilities/capabilities_list/","result":{"data":{"asciidoc":{"id":"0865f012-163e-5023-970d-40d9b33fc153","html":"
\n
Table of Contents
\n\n
\n
\n
\n
\n

In HIRO™ you can use action handlers to performs activities in other\napplications and systems. Available commands are specified as Capabilities in\nthe HIRO™ platform. In the list below you can find the specified capabilities,\nsorted by application area.

\n
\n
\n
\n
\n

Overview of application areas:

\n
\n
\n\n
\n
\n
\n
\n

Area Advertising

\n
\n
\n

DBM-Create-Query

\n
\n

Create Query in DBM

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {},\n  \"ogit/Automation/optionalParameters\": {\n    \"dataRange\": {\n      \"description\": \"dataRange\"\n    },\n    \"title\": {\n      \"description\": \"title\"\n    },\n    \"queryType\": {\n      \"description\": \"queryType\",\n      \"default\": \"TYPE_GENERAL\"\n    },\n    \"groupBys\": {\n      \"description\": \"groupBys\",\n      \"default\": \"FILTER_ADVERTISER_CURRENCY\"\n    },\n    \"filters\": {\n      \"description\": \"filters\"\n    },\n    \"metrics\": {\n      \"description\": \"metrics\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DBM-Download-Report

\n
\n

Download Report from DBM

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"linkLatestReport\": {\n      \"description\": \"Link to the latest report\"\n    },\n    \"target_xid\": {\n      \"description\": \"Xid of node to put the report into\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"startTimeMs\": {\n      \"description\": \"startTimeMs\",\n      \"default\": \"\"\n    }\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DBM-Get-Query

\n
\n

Get Query from DBM

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"queryId\": {\n      \"description\": \"Id of query\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"startTimeMs\": {\n      \"description\": \"startTimeMs\",\n      \"default\": \"\"\n    }\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DBM-Run-Query

\n
\n

Run Query in DBM

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {},\n  \"ogit/Automation/optionalParameters\": {\n    \"dataRange\": {\n      \"description\": \"dataRange\"\n    },\n    \"startTimeMs\": {\n      \"description\": \"startTimeMs\",\n      \"default\": \"\"\n    },\n    \"endTimeMs\": {\n      \"description\": \"endTimeMs\",\n      \"default\": \"\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Check-Updated-InsertionOrders

\n
\n

Check Updated InsertionOrders from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"filter\": {\n      \"description\": \"filter for request\",\n      \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n    },\n    \"lastUpdate\": {\n      \"description\": \"Timestamp of last update\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Check-Updated-LineItems

\n
\n

Check Updated LineItems from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"insertionOrderId\": {\n      \"description\": \"id of insertionOrder\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"filter\": {\n      \"description\": \"filter for request\",\n      \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n    },\n    \"lastUpdate\": {\n      \"description\": \"Timestamp of last update\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Create-and-Import-InsertionOrder

\n
\n

Create and import InsertionOrder from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"campaignId\": {\n      \"description\": \"id of campaign\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"displayName\": {\n      \"description\": \"displayName\"\n    },\n    \"entityStatus\": {\n      \"description\": \"entityStatus\",\n      \"default\": \"ENTITY_STATUS_DRAFT\"\n    },\n    \"pacingPeriod\": {\n      \"description\": \"pacingPeriod\"\n    },\n    \"pacingType\": {\n      \"description\": \"pacingType\"\n    },\n    \"timeUnit\": {\n      \"description\": \"timeUnit\"\n    },\n    \"timeUnitCount\": {\n      \"description\": \"timeUnitCount\"\n    },\n    \"maxImpressions\": {\n      \"description\": \"maxImpressions\"\n    },\n    \"performanceGoalType\": {\n      \"description\": \"performanceGoalType\"\n    },\n    \"performanceGoalAmountMicros\": {\n      \"description\": \"performanceGoalAmountMicros\"\n    },\n    \"budgetUnit\": {\n      \"description\": \"budgetUnit\"\n    },\n    \"budgetAmountMicros\": {\n      \"description\": \"budgetAmountMicros\"\n    },\n    \"startDate\": {\n      \"description\": \"startDate\"\n    },\n    \"endDate\": {\n      \"description\": \"endDate\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Create-and-Import-LineItem

\n
\n

Create and import LineItem from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"insertionOrderId\": {\n      \"description\": \"id of insertionOrder\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"displayName\": {\n      \"description\": \"displayName\"\n    },\n    \"lineItemType\": {\n      \"description\": \"lineItemType\"\n    },\n    \"entityStatus\": {\n      \"description\": \"entityStatus\",\n      \"default\": \"ENTITY_STATUS_DRAFT\"\n    },\n    \"flightDateType\": {\n      \"description\": \"flightDateType\"\n    },\n    \"startDate\": {\n      \"description\": \"startDate\"\n    },\n    \"endDate\": {\n      \"description\": \"endDate\"\n    },\n    \"budgetAllocationType\": {\n      \"description\": \"budgetAllocationType\"\n    },\n    \"maxAmount\": {\n      \"description\": \"maxAmount\"\n    },\n    \"pacingPeriod\": {\n      \"description\": \"pacingPeriod\"\n    },\n    \"pacingType\": {\n      \"description\": \"pacingType\"\n    },\n    \"timeUnit\": {\n      \"description\": \"timeUnit\"\n    },\n    \"timeUnitCount\": {\n      \"description\": \"timeUnitCount\"\n    },\n    \"maxImpressions\": {\n      \"description\": \"maxImpressions\"\n    },\n    \"markupType\": {\n      \"description\": \"markupType\"\n    },\n    \"markupAmount\": {\n      \"description\": \"markupAmount\"\n    },\n    \"budgetAmountMicros\": {\n      \"description\": \"budgetAmountMicros\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-Advertiser-by-Id

\n
\n

Import Advertiser by Id from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-Advertisers-by-Partner

\n
\n

Import Advertisers by Partner from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"partnerId\": {\n      \"description\": \"id of partner\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"filter\": {\n      \"description\": \"filter for request\",\n      \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n    },\n    \"fields\": {\n      \"description\": \"fields for request\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-InsertionOrder-by-Id

\n
\n

Import InsertionOrder by Id from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"insertionOrderId\": {\n      \"description\": \"id of insertionOrder\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-InsertionOrders-by-Advertiser

\n
\n

Import InsertionOrders by Advertiser from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"filter\": {\n      \"description\": \"filter for request\",\n      \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n    },\n    \"fields\": {\n      \"description\": \"fields for request\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-LineItem-by-Id

\n
\n

Import LineItem by Id from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"lineItemId\": {\n      \"description\": \"id of lineItem\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Import-LineItems-by-InsertionOrder

\n
\n

Import LineItems by InsertionOrder from DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"insertionOrderId\": {\n      \"description\": \"id of insertionOrder\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"filter\": {\n      \"description\": \"filter for request\",\n      \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n    },\n    \"fields\": {\n      \"description\": \"fields for request\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Patch-InsertionOrder

\n
\n

Patch InsertionOrder in DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"insertionOrderId\": {\n      \"description\": \"id of insertionOrder\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"xid\": {\n      \"description\": \"xid\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DV360-Patch-LineItem

\n
\n

Patch LineItem in DV360

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"advertiserId\": {\n      \"description\": \"id of advertiser\"\n    },\n    \"lineItemId\": {\n      \"description\": \"id of lineItem\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"xid\": {\n      \"description\": \"xid\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Check-Updated-AdGroups

\n
\n

Check Updated AdGroups in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"CampaignId\": {\n      \"description\": \"id of campaign\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"LastChangeTrackingVersion\": {\n      \"description\": \"LastChangeTrackingVersion\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Check-Updated-Campaigns

\n
\n

Check Updated Campaigns from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"AdvertiserId\": {\n      \"description\": \"id of advertiser\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"LastChangeTrackingVersion\": {\n      \"description\": \"LastChangeTrackingVersion\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Create-AdGroup

\n
\n

Create AdGroup in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"CampaignId\": {\n      \"description\": \"CampaignId\"\n    },\n    \"AdGroupName\": {\n      \"description\": \"AdGroupName\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"IsEnabled\": {\n      \"description\": \"IsEnabled\"\n    },\n    \"IsHighFillRate\": {\n      \"description\": \"IsHighFillRate\"\n    },\n    \"IndustryCategoryId\": {\n      \"description\": \"IndustryCategoryId\"\n    },\n    \"CurrencyCode\": {\n      \"description\": \"CurrencyCode\"\n    },\n    \"Budget\": {\n      \"description\": \"Budget\"\n    },\n    \"BudgetInImpressions\": {\n      \"description\": \"BudgetInImpressions\"\n    },\n    \"DailyBudget\": {\n      \"description\": \"DailyBudget\"\n    },\n    \"DailyBudgetInImpressions\": {\n      \"description\": \"DailyBudgetInImpressions\"\n    },\n    \"PacingMode\": {\n      \"description\": \"PacingMode\"\n    },\n    \"AutoAllocatorPriority\": {\n      \"description\": \"AutoAllocatorPriority\"\n    },\n    \"BaseBidCPM\": {\n      \"description\": \"BaseBidCPM\"\n    },\n    \"MaxBidCPM\": {\n      \"description\": \"MaxBidCPM\"\n    },\n    \"Description\": {\n      \"description\": \"Description\"\n    },\n    \"Availability\": {\n      \"description\": \"Availability\"\n    },\n    \"PredictiveClearingEnabled\": {\n      \"description\": \"PredictiveClearingEnabled\"\n    },\n    \"CreativeId\": {\n      \"description\": \"CreativeId\"\n    },\n    \"BidListId\": {\n      \"description\": \"BidListId\"\n    },\n    \"IsClassic\": {\n      \"description\": \"IsClassic\"\n    },\n    \"AudienceId\": {\n      \"description\": \"AudienceId\"\n    },\n    \"FrequencyCap\": {\n      \"description\": \"FrequencyCap\"\n    },\n    \"FrequencyPeriodInMinutes\": {\n      \"description\": \"FrequencyPeriodInMinutes\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Create-BidList

\n
\n

Create BidList in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Name\": {\n      \"description\": \"Name of BidList\"\n    },\n    \"BidListAdjustmentType\": {\n      \"description\": \"BidListAdjustmentType\"\n    },\n    \"BidListOwner\": {\n      \"description\": \"BidListOwner\"\n    },\n    \"BidListOwnerId\": {\n      \"description\": \"BidListOwnerId\"\n    },\n    \"ResolutionType\": {\n      \"description\": \"ResolutionType\"\n    },\n    \"IsAvailableForLibraryUse\": {\n      \"description\": \"IsAvailableForLibraryUse\"\n    },\n    \"BidLines\": {\n      \"description\": \"BidLines\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Create-Campaign

\n
\n

Create Campaigns in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"AdvertiserId\": {\n      \"description\": \"AdvertiserId\"\n    },\n    \"CampaignName\": {\n      \"description\": \"CampaignName\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"AutoallocatorEnabled\": {\n      \"description\": \"AutoallocatorEnabled\"\n    },\n    \"AutoPrioritizationEnabled\": {\n      \"description\": \"AutoPrioritizationEnabled\"\n    },\n    \"PacingMode\": {\n      \"description\": \"PacingMode\"\n    },\n    \"StartDate\": {\n      \"description\": \"StartDate\"\n    },\n    \"EndDate\": {\n      \"description\": \"EndDate\"\n    },\n    \"Budget\": {\n      \"description\": \"Budget\"\n    },\n    \"CurrencyCode\": {\n      \"description\": \"CurrencyCode\"\n    },\n    \"BudgetInImpressions\": {\n      \"description\": \"BudgetInImpressions\"\n    },\n    \"DailyBudget\": {\n      \"description\": \"DailyBudget\"\n    },\n    \"DailyBudgetInImpressions\": {\n      \"description\": \"DailyBudgetInImpressions\"\n    },\n    \"CampaignType\": {\n      \"description\": \"CampaignType\"\n    },\n    \"Description\": {\n      \"description\": \"Description\"\n    },\n    \"CustomLabelId\": {\n      \"description\": \"CustomLabelId\"\n    },\n    \"Availability\": {\n      \"description\": \"Availability\"\n    },\n    \"PartnerCostPercentageFee\": {\n      \"description\": \"PartnerCostPercentageFee\"\n    },\n    \"PurchaseOrderNumber\": {\n      \"description\": \"PurchaseOrderNumber\"\n    },\n    \"TimeZone\": {\n      \"description\": \"TimeZone\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Download-Report

\n
\n

Download Report from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"target_xid\": {\n      \"description\": \"The ogit\\/_xid of the target vertex for the report.\"\n    },\n    \"DownloadURI\": {\n      \"description\": \"URI in Tradedesk to download the report from.\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Get-Query

\n
\n

Get Query in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"ReportScheduleIds\": {\n      \"description\": \"The Schedule IDs of Report Executions to retrieve.\"\n    },\n    \"AdvertiserIds\": {\n      \"description\": \"The ID of the Advertisers for whom to retrieve Report Executions. Each execution that contains data for at least one of these Advertisers will match the query.\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-AdGroup-by-Id

\n
\n

Import AdGroup by Id from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"AdgroupIdList\": {\n      \"description\": \"id of adgroup\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-Advertiser-by-Id

\n
\n

Import Advertiser by Id from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"AdvertiserIdList\": {\n      \"description\": \"id or list of ids of advertisers\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-Advertisers-by-Partner

\n
\n

Import Advertisers by Partner from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {},\n  \"ogit/Automation/optionalParameters\": {\n    \"PartnerId\": {\n      \"description\": \"id of partner\"\n    },\n    \"Availabilities\": {\n      \"description\": \"the Availabilities\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-BidList-by-Id

\n
\n

Import BidList By Id in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"BidListId\": {\n      \"description\": \"id of BidList\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-Campaign-by-Id

\n
\n

Import Campaigns by Id from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"CampaignIdList\": {\n      \"description\": \"id or list of ids of campaigns\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Import-Campaigns-by-Id

\n
\n

Import Campaigns by Id from TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"CampaignId\": {\n      \"description\": \"id of campaign\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Patch-AdGroup

\n
\n

Patch AdGroup

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"xid\": {\n      \"description\": \"The XID of the campaign\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Patch-Campaign

\n
\n

Patch Campaign

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"xid\": {\n      \"description\": \"ogit\\/_xid of the associated vertex\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TTD-Run-Query

\n
\n

Run Query in TradeDesk

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"ReportTemplateId\": {\n      \"description\": \"The ID of the Report Template to which this Report Schedule applies. Use the myreports\\/reporttemplateheader\\/query endpoint to obtain a suitable template ID if you do not have one.\"\n    },\n    \"ReportScheduleName\": {\n      \"description\": \"The name of the Report Schedule.\"\n    },\n    \"ReportDateRange\": {\n      \"description\": \"The date range for the Report Schedule. If this is LastXDays, ReportDaysPrevious field must be supplied. If this is Custom, ReportStartDate and ReportEndDate must be supplied.\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"CampaignFilters\": {\n      \"description\": \"The list of campaigns on which to filter the report. Exactly one of PartnerFilters, AdvertiserFilters, CampaignFilters or AdGroupFilters must be set.\",\n      \"default\": \"\"\n    },\n    \"AdGroupFilters\": {\n      \"description\": \"The list of ad groups on which to filter the report.\",\n      \"default\": \"\"\n    },\n    \"ReportFileFormat\": {\n      \"description\": \"The file format for the report.\",\n      \"default\": \"CSV\"\n    },\n    \"ReportFrequency\": {\n      \"description\": \"The frequency of the report schedule. Once is always valid; Daily and Weekly are valid for all ReportDateRange except LastMonth and Custom; Month is valid for MonthToDate, QuarterToDate and LastMonth.\",\n      \"default\": \"Once\"\n    },\n    \"ReportDateFormat\": {\n      \"description\": \"The format used for dates.\",\n      \"default\": \"Sortable\"\n    },\n    \"ReportNumericFormat\": {\n      \"description\": \"The format used for numeric values.\",\n      \"default\": \"US\"\n    },\n    \"TimeZone\": {\n      \"description\": \"The Olson timezone of the Report Schedule.Note that UTC is represented by \\\"UTC\\\" instead of the official Olson timezone string of \\\"Etc\\/UTC\\\".\",\n      \"default\": \"UTC\"\n    },\n    \"IncludeHeaders\": {\n      \"description\": \"Whether or not to include column headers in the report. Only valid for Text reports.\",\n      \"default\": \"true\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 300000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area Analytics

\n
\n
\n

ClassifierPredict

\n
\n

Request prediction for training model

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"classifier_name\": {\n      \"description\": \"Name of prediction model\"\n    },\n    \"input_string\": {\n      \"description\": \"The value for which the category should be calculated\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"Request timeout\",\n      \"default\": 3000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {\n    \"exitcode\": {\n      \"description\": \"exit status of command (0 is success)\"\n    },\n    \"category\": {\n      \"description\": \"The predicted category\"\n    },\n    \"probability\": {\n      \"description\": \"The confidence level of prediction\"\n    }\n  }\n}
\n
\n
\n
\n
\n
\n
\n

ClassifierTrain

\n
\n

Send train request

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"trainingdata_id\": {\n      \"description\": \"ogit\\/_id of ogit\\/ML\\/TrainedModel\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"Request timeout\",\n      \"default\": 3000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {\n    \"exitcode\": {\n      \"description\": \"exit status of command (0 is success)\"\n    },\n    \"message\": {\n      \"description\": \"Training response message\"\n    }\n  }\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area Generic

\n
\n
\n

AskApprove

\n
\n

Ask approve to process the issue

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"user_email\": {\n      \"description\": \"User's email to ask\"\n    },\n    \"issue_id\": {\n      \"description\": \"processing issue id\"\n    },\n    \"question_model\": {\n      \"description\": \"Special question model to generate a question\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 10000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

CSVtoSpreadsheet

\n
\n

Convert csv to spreadsheet

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"sourceId\": {\n      \"description\": \"ogit\\/_id of the ogit\\/Attachment that contains the CSV blob\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"keys\": {\n      \"description\": \"Identifier if keys are represented by rows or columns\",\n      \"default\": \"row\"\n    },\n    \"colOffset\": {\n      \"description\": \"Offset columns of the table. Entries before the offset are ignored.\",\n      \"default\": \"0\"\n    },\n    \"rowOffset\": {\n      \"description\": \"Offset rows of the table. Entries before the offset are ignored.\",\n      \"default\": \"0\"\n    },\n    \"delimiter\": {\n      \"description\": \"Delimiting character\",\n      \"default\": \",\"\n    },\n    \"targetXid\": {\n      \"description\": \"ogit\\/_xid of the node where the result is to be stored\",\n      \"default\": \"\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 10000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

DateConverter

\n
\n

Converts a date from an initial format to another

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"date_string\": {\n      \"description\": \"date_string parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"in_format\": {\n      \"description\": \"in_format parameter\"\n    },\n    \"out_format\": {\n      \"description\": \"out_format parameter\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

HTTPRequest

\n
\n

Make HTTP request

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"url\": {\n      \"description\": \"Request URL\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"method\": {\n      \"description\": \"HTTP request type (GET,POST,PUT,DELETE)\",\n      \"default\": \"GET\"\n    },\n    \"body\": {\n      \"description\": \"Body to send for post requests\",\n      \"default\": \"\"\n    },\n    \"headers\": {\n      \"description\": \"Headers to send\",\n      \"default\": \"Content-Type= application\\/json\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 10000\n    },\n    \"certname\":\n    {\n      \"description\": \"Name of the client certificate to use\",\n      \"default\": \"\"\n    },\n    \"username\":\n    {\n      \"description\": \"Username for basic auth\",\n      \"default\": \"\"\n    },\n    \"password\":\n    {\n      \"description\": \"Password for basic auth\",\n      \"default\": \"\"\n    },\n    \"oauth\": {\n      \"description\": \"Identifier of an OAuth configuration set\",\n      \"default\": \"\"\n    },\n    \"allow_insecure_https\": {\n      \"description\": \"Allow unverified SSL connections\",\n      \"default\": \"false\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {\n    \"body\": {\n      \"description\": \"HTTP result body\"\n    },\n    \"code\": {\n      \"description\": \"HTTP response code\"\n    },\n    \"headers\": {\n      \"description\": \"HTTP response headers\"\n    }\n  }\n}
\n
\n
\n
\n
\n
\n
\n

SendEmail

\n
\n

Send an email with KI

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"from\": {\n      \"description\": \"Who sends an email\"\n    },\n    \"to\": {\n      \"description\": \"Who is a receiver\"\n    },\n    \"subject\": {\n      \"description\": \"Subject of an email\"\n    },\n    \"body\": {\n      \"description\": \"Body of an email\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"type\": {\n      \"description\": \"Type of the content pain or html\",\n      \"default\": \"plain\"\n    },\n    \"cc\": {\n      \"description\": \"cc receivers\",\n      \"default\": \"\"\n    },\n    \"bcc\": {\n      \"description\": \"bcc receivers\",\n      \"default\": \"\"\n    },\n    \"timeout\": {\n      \"description\": \"HTTP request timeout\",\n      \"default\": 10000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SMSConnector

\n
\n

API to send SMS messages

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Arguments\": {\n      \"description\": \"Arguments parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"issue\": {\n      \"description\": \"issue parameter\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SOAPRequest

\n
\n

execute soap call on remote host

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"SOAPRequest\": {\n      \"description\": \"soap request payload\"\n    },\n    \"SOAPEndpoint\": {\n      \"description\": \"endpoint url of soap service\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area IT Service Management (ITSM)

\n
\n
\n

AWXExecuteJobTemplate

\n
\n

Execute a JobTemplate in AWX

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"templateName\": {\n      \"description\": \"templateName\"\n    },\n    \"hostname\": {\n      \"description\": \"hostname\"\n    },\n    \"taskId\": {\n      \"description\": \"taskId\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"extraVariables\": {\n      \"description\": \"extraVariables\",\n      \"default\": \"{}\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ExecuteCommand

\n
\n

execute a command on a remote host

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"command\": {\n      \"description\": \"command to execute\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"host\": {\n      \"description\": \"hostname to execute command on\",\n      \"default\": \"\"\n    },\n    \"user\": {\n      \"description\": \"user to run the command as\",\n      \"default\": \"\"\n    },\n    \"timeout\": {\n      \"description\": \"timeout in seconds\",\n      \"default\": \"120\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ExecuteLocalCommand

\n
\n

ExecuteLocalCommand

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Command\": {\n      \"description\": \"Command parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"timeout parameter\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ExecuteMysqlQueryCq

\n
\n

Execute Mysql Queries

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"query\": {\n      \"description\": \"Query string that will be execute on the Mysql DB\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"SHH request timeout\",\n      \"default\": 10000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ExecuteOracleQueryCq

\n
\n

Execute Oracle Queries

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"query\": {\n      \"description\": \"Query string that will be execute on the Oracle DB\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"SHH request timeout\",\n      \"default\": 10000\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ExecuteWindowsCommand

\n
\n

Executes command over PS-Remoting on Windows endpoint

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"host\": {\n      \"description\": \"Target endpoint Windows system\"\n    },\n    \"command_type\": {\n      \"description\": \"Type of command CMD or PowerShell\"\n    },\n    \"command\": {\n      \"description\": \"Cmdlet name or command\"\n    },\n    \"arguments\": {\n      \"description\": \"Space-separated list of command arguments\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

GetVMInfo

\n
\n

Retrieves information about a specific VM

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"vmname\": {\n      \"description\": \"vmname\"\n    },\n    \"vcenter\": {\n      \"description\": \"vcenter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RunLocalScript

\n
\n

RunLocalScript

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Command\": {\n      \"description\": \"Command\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RunScript

\n
\n

this one executes scripts

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"command\": {\n      \"description\": \"script to run\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"timeout\": {\n      \"description\": \"timeout in seconds\",\n      \"default\": \"120\"\n    },\n    \"workdir\": {\n      \"description\": \"working directory for the script\",\n      \"default\": \"\\/tmp\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SelfMonitoringExecution

\n
\n

run script on remote host

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Command\": {\n      \"description\": \"script to execute\"\n    },\n    \"Hostname\": {\n      \"description\": \"host to execute script on\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"User\": {\n      \"description\": \"target user\"\n    },\n    \"SshOpts\": {\n      \"description\": \"SSH options\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

CalculateNoOfSecondsBetweenDates

\n
\n

calculate the number of seconds between two dates

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"endDate\": {\n      \"description\": \"endDate parameter\"\n    },\n    \"currentDate\": {\n      \"description\": \"currentDate parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area SAP

\n
\n
\n

SAPAutomatizaStringSet

\n
\n

Query AutomatizaStringSet from SAP

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"I_Trax\": {\n      \"description\": \"I_Trax\",\n      \"default\": \"\"\n    },\n    \"I_Vista\": {\n      \"description\": \"I_Vista\",\n      \"default\": \"\"\n    },\n    \"I_Batch\": {\n      \"description\": \"I_Batch\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SAPQueryOtSet

\n
\n

Query OT data set from SAP

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"QueryOtSet1\": {\n      \"description\": \"First parameter of QueryOtSet\",\n      \"default\": \"ot\"\n    },\n    \"QueryOtSet2\": {\n      \"description\": \"Second parameter of QueryOtSet\",\n      \"default\": \"\"\n    },\n    \"QueryOtSet3\": {\n      \"description\": \"Third parameter of QueryOtSet\",\n      \"default\": \"break\"\n    },\n    \"QueryOtSet4\": {\n      \"description\": \"Fourth parameter of QueryOtSet\",\n      \"default\": \"0\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SAPQuerySet

\n
\n

Query data set from SAP

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"TabQuerySet\": {\n      \"description\": \"JSON structure for the SAP query\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SAPRequest

\n
\n

Request an SAP Remote Function Call (RFC) execution

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"function\": {\n      \"description\": \"Remote Function Call (RFC)\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"destination\": {\n      \"description\": \"SAP destination\",\n      \"default\": \"\"\n    },\n    \"parameters\": {\n      \"description\": \"Parameters for the RFC\",\n      \"default\": \"{}\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SAPUserGetDetail

\n
\n

Get the details of a user in SAP

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"SID\": {\n      \"description\": \"SID\"\n    },\n    \"CLIENT\": {\n      \"description\": \"CLIENT\"\n    },\n    \"USER\": {\n      \"description\": \"USER\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SAPUserUnlock

\n
\n

Unlock a user in SAP

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"SID\": {\n      \"description\": \"SID\"\n    },\n    \"CLIENT\": {\n      \"description\": \"CLIENT\"\n    },\n    \"USER\": {\n      \"description\": \"USER\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area Ticket Systems

\n
\n
\n

CreateJiraIssue

\n
\n

Create a Jira Issue

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Project\": {\n      \"description\": \"Unique id of the Jira project for the new issue (project: {key: Project})\",\n      \"default\": \"\"\n    },\n    \"IncidentType\": {\n      \"description\": \"Id of the type of issue to be created in Jira (issuetype: {name: IncidentType})\",\n      \"default\": \"\"\n    },\n    \"Subject\": {\n      \"description\": \"Title of the Jira issue (summary)\",\n      \"default\": \"\"\n    },\n    \"Description\": {\n      \"description\": \"Body of the Jira issue (description)\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"IncidentStatus\": {\n      \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n    },\n    \"IncidentStatusId\": {\n      \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n    },\n    \"PriorityId\": {\n      \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n    },\n    \"InformerId\": {\n      \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n    },\n    \"Informer\": {\n      \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n    },\n    \"InformerKey\": {\n      \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n    },\n    \"ResponsibleId\": {\n      \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n    },\n    \"Responsible\": {\n      \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n    },\n    \"ResponsibleKey\": {\n      \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n    },\n    \"CreatorId\": {\n      \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n    },\n    \"Creator\": {\n      \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n    },\n    \"CreatorKey\": {\n      \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n    },\n    \"TicketKey\": {\n      \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\"\n    },\n    \"Comment\": {\n      \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n    },\n    \"Impact\": {\n      \"description\": \"customfield_10500\"\n    },\n    \"Phone\": {\n      \"description\": \"customfield_12803\"\n    },\n    \"Urgency\": {\n      \"description\": \"customfield_10501\"\n    },\n    \"Classification\": {\n      \"description\": \"customfield_11396\"\n    },\n    \"ApplicantId\": {\n      \"description\": \"customfield_12900\"\n    },\n    \"ApplicantOrganization\": {\n      \"description\": \"customfield_11614\"\n    },\n    \"City\": {\n      \"description\": \"customfield_12804\"\n    },\n    \"FirstName\": {\n      \"description\": \"customfield_11365\"\n    },\n    \"WaitTime\": {\n      \"description\": \"customfield_11110\"\n    },\n    \"TicketTypeId\": {\n      \"description\": \"customfield_11349: { id: TicketTypeId }\"\n    },\n    \"TicketType\": {\n      \"description\": \"customfield_11349: { value: TicketType }\"\n    },\n    \"Email\": {\n      \"description\": \"customfield_11333\"\n    },\n    \"Provider\": {\n      \"description\": \"customfield_11332\"\n    },\n    \"ApprovalStatus\": {\n      \"description\": \"customfield_11325\"\n    },\n    \"ClosingReason\": {\n      \"description\": \"customfield_11320\"\n    },\n    \"AssignedGroup\": {\n      \"description\": \"customfield_11310\"\n    },\n    \"Sla\": {\n      \"description\": \"customfield_11312\"\n    },\n    \"Product\": {\n      \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n    },\n    \"Product1\": {\n      \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n    },\n    \"Product2\": {\n      \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n    },\n    \"Product3\": {\n      \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n    },\n    \"ActionId\": {\n      \"description\": \"customfield_11308: { id: ActionId }\"\n    },\n    \"Action\": {\n      \"description\": \"customfield_11308:  { value: Action }\"\n    },\n    \"SupportOrganizationId\": {\n      \"description\": \"customfield_11309: { id: OrganizationId }\"\n    },\n    \"SupportOrganization\": {\n      \"description\": \"customfield_11309: { value: Organization }\"\n    },\n    \"SubSupportOrganizationId\": {\n      \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n    },\n    \"SubSupportOrganization\": {\n      \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n    },\n    \"RequestType\": {\n      \"description\": \"customfield_11302\"\n    },\n    \"ProviderNumber\": {\n      \"description\": \"customfield_11403\"\n    },\n    \"Process\": {\n      \"description\": \"customfield_11607\"\n    },\n    \"AssociatedChange\": {\n      \"description\": \"customfield_11606\"\n    },\n    \"Authorizer\": {\n      \"description\": \"customfield_11390\"\n    },\n    \"AmountChangesEnd\": {\n      \"description\": \"customfield_11619\"\n    },\n    \"AmountChangesTime\": {\n      \"description\": \"customfield_11620\"\n    },\n    \"AmountReopen\": {\n      \"description\": \"customfield_11317\"\n    },\n    \"ChangeCause\": {\n      \"description\": \"customfield_11908\"\n    },\n    \"ApproverQuery\": {\n      \"description\": \"customfield_11823\"\n    },\n    \"ApproverQueryURL\": {\n      \"description\": \"customfield_11820\"\n    },\n    \"ScheduledFinishAt\": {\n      \"description\": \"customfield_11359\"\n    },\n    \"ScheduledStartAt\": {\n      \"description\": \"customfield_11386\"\n    },\n    \"SubTask\": {\n      \"description\": \"subtasks\"\n    },\n    \"RequirementAction\": {\n      \"description\": \"customfield_11608\"\n    },\n    \"Department\": {\n      \"description\": \"customfield_11328\"\n    },\n    \"Company\": {\n      \"description\": \"customfield_11327\"\n    },\n    \"TargetStartAt\": {\n      \"description\": \"customfield_11602\"\n    },\n    \"TargetFinishAt\": {\n      \"description\": \"customfield_11615\"\n    },\n    \"OriginalEndDate\": {\n      \"description\": \"customfield_11618\"\n    },\n    \"ExecutionOrder\": {\n      \"description\": \"customfield_11319\"\n    },\n    \"ReportedSourceId\": {\n      \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n    },\n    \"ReportedSource\": {\n      \"description\": \"customfield_11352: { value: ReportedSource }\"\n    },\n    \"Labels\": {\n      \"description\": \"labels: [ Labels as csv ]\"\n    },\n    \"ResolutionMethod\": {\n      \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n    },\n    \"ResolutionDetail\": {\n      \"description\": \"customfield_11345\"\n    },\n    \"RequirementType\": {\n      \"description\": \"customfield_11901\"\n    },\n    \"LinkedTicket\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n    },\n    \"LinkedTicketType\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n    },\n    \"TransportOrder\": {\n      \"description\": \"customfield_11398\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

OMCreateRequest

\n
\n

Create Operations Manager Request

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"antragsart\": {\n      \"description\": \"\"\n    },\n    \"database\": {\n      \"description\": \"\"\n    },\n    \"server\": {\n      \"description\": \"\"\n    },\n    \"url\": {\n      \"description\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"parameters\": {\n      \"description\": \"additional parameters\",\n      \"default\": \"\"\n    },\n    \"environment\": {\n      \"description\": \"environment of target systems\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

OMGetRequestStatus

\n
\n

Get the status of an Operations Manager Request

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"requestid\": {\n      \"description\": \"id of the OM request to query\"\n    },\n    \"database\": {\n      \"description\": \"\"\n    },\n    \"server\": {\n      \"description\": \"\"\n    },\n    \"url\": {\n      \"description\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"environment\": {\n      \"description\": \"environment of the target systems\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RemedyAddWorklog

\n
\n

Add a Worklog entry to a ticket in Remedy

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"remedyId\": {\n      \"description\": \"remedyId\"\n    },\n    \"message\": {\n      \"description\": \"message\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"viewAccess\": {\n      \"description\": \"viewAccess\",\n      \"default\": \"Public\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RemedyGetTicket

\n
\n

Get ticket from remedy

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"remedyId\": {\n      \"description\": \"remedyId\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"env\": {\n      \"description\": \"which environment to connect to? (PROD\\/DEV)\",\n      \"default\": \"PROD\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RemedySetAssignee

\n
\n

Set Assignee of a ticket in Remedy

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"remedyId\": {\n      \"description\": \"remedyId\"\n    },\n    \"assignee\": {\n      \"description\": \"assignee\"\n    },\n    \"assigneeLoginId\": {\n      \"description\": \"assigneeLoginId\"\n    },\n    \"message\": {\n      \"description\": \"message\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"hiroProcessed\": {\n      \"description\": \"issueId\",\n      \"default\": \"Yes\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

RemedySetStatus

\n
\n

Change Status of a ticket in Remedy

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"remedyId\": {\n      \"description\": \"remedyId\"\n    },\n    \"status\": {\n      \"description\": \"status\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"statusReason\": {\n      \"description\": \"statusReason\",\n      \"default\": \"\"\n    },\n    \"resolution\": {\n      \"description\": \"resolution\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

TransistJiraIssue

\n
\n

Transist a Jira Issue to a new state. This is also used to resolve a ticket.

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"TicketId\": {\n      \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\",\n      \"default\": \"\"\n    },\n    \"TransitionId\": {\n      \"description\": \"Id of the transition state that this ticket shall move to. (transition: {id: TransitionId}})\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"IncidentStatus\": {\n      \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n    },\n    \"IncidentStatusId\": {\n      \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n    },\n    \"Comment\": {\n      \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n    },\n    \"Resolution\": {\n      \"description\": \"Text describing the resolution (resolution)\"\n    },\n    \"Resolved\": {\n      \"description\": \"Date of resolution (resolutiondate)\"\n    },\n    \"PriorityId\": {\n      \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n    },\n    \"Subject\": {\n      \"description\": \"Title of the Jira issue (summary)\"\n    },\n    \"Description\": {\n      \"description\": \"Body of the Jira issue (description)\"\n    },\n    \"InformerId\": {\n      \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n    },\n    \"Informer\": {\n      \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n    },\n    \"InformerKey\": {\n      \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n    },\n    \"ResponsibleId\": {\n      \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n    },\n    \"Responsible\": {\n      \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n    },\n    \"ResponsibleKey\": {\n      \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n    },\n    \"CreatorId\": {\n      \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n    },\n    \"Creator\": {\n      \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n    },\n    \"CreatorKey\": {\n      \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n    },\n    \"Impact\": {\n      \"description\": \"customfield_10500\"\n    },\n    \"Phone\": {\n      \"description\": \"customfield_12803\"\n    },\n    \"Urgency\": {\n      \"description\": \"customfield_10501\"\n    },\n    \"Classification\": {\n      \"description\": \"customfield_11396\"\n    },\n    \"ApplicantId\": {\n      \"description\": \"customfield_12900\"\n    },\n    \"ApplicantOrganization\": {\n      \"description\": \"customfield_11614\"\n    },\n    \"City\": {\n      \"description\": \"customfield_12804\"\n    },\n    \"FirstName\": {\n      \"description\": \"customfield_11365\"\n    },\n    \"WaitTime\": {\n      \"description\": \"customfield_11110\"\n    },\n    \"TicketTypeId\": {\n      \"description\": \"customfield_11349: { id: TicketTypeId }\"\n    },\n    \"TicketType\": {\n      \"description\": \"customfield_11349: { value: TicketType }\"\n    },\n    \"Email\": {\n      \"description\": \"customfield_11333\"\n    },\n    \"Provider\": {\n      \"description\": \"customfield_11332\"\n    },\n    \"ApprovalStatus\": {\n      \"description\": \"customfield_11325\"\n    },\n    \"ClosingReason\": {\n      \"description\": \"customfield_11320\"\n    },\n    \"AssignedGroup\": {\n      \"description\": \"customfield_11310\"\n    },\n    \"Sla\": {\n      \"description\": \"customfield_11312\"\n    },\n    \"Product\": {\n      \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n    },\n    \"Product1\": {\n      \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n    },\n    \"Product2\": {\n      \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n    },\n    \"Product3\": {\n      \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n    },\n    \"ActionId\": {\n      \"description\": \"customfield_11308: { id: ActionId }\"\n    },\n    \"Action\": {\n      \"description\": \"customfield_11308:  { value: Action }\"\n    },\n    \"SupportOrganizationId\": {\n      \"description\": \"customfield_11309: { id: OrganizationId }\"\n    },\n    \"SupportOrganization\": {\n      \"description\": \"customfield_11309: { value: Organization }\"\n    },\n    \"SubSupportOrganizationId\": {\n      \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n    },\n    \"SubSupportOrganization\": {\n      \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n    },\n    \"RequestType\": {\n      \"description\": \"customfield_11302\"\n    },\n    \"ProviderNumber\": {\n      \"description\": \"customfield_11403\"\n    },\n    \"Process\": {\n      \"description\": \"customfield_11607\"\n    },\n    \"AssociatedChange\": {\n      \"description\": \"customfield_11606\"\n    },\n    \"Authorizer\": {\n      \"description\": \"customfield_11390\"\n    },\n    \"AmountChangesEnd\": {\n      \"description\": \"customfield_11619\"\n    },\n    \"AmountChangesTime\": {\n      \"description\": \"customfield_11620\"\n    },\n    \"AmountReopen\": {\n      \"description\": \"customfield_11317\"\n    },\n    \"ChangeCause\": {\n      \"description\": \"customfield_11908\"\n    },\n    \"ApproverQuery\": {\n      \"description\": \"customfield_11823\"\n    },\n    \"ApproverQueryURL\": {\n      \"description\": \"customfield_11820\"\n    },\n    \"ScheduledFinishAt\": {\n      \"description\": \"customfield_11359\"\n    },\n    \"ScheduledStartAt\": {\n      \"description\": \"customfield_11386\"\n    },\n    \"SubTask\": {\n      \"description\": \"subtasks\"\n    },\n    \"RequirementAction\": {\n      \"description\": \"customfield_11608\"\n    },\n    \"Department\": {\n      \"description\": \"customfield_11328\"\n    },\n    \"Company\": {\n      \"description\": \"customfield_11327\"\n    },\n    \"TargetStartAt\": {\n      \"description\": \"customfield_11602\"\n    },\n    \"TargetFinishAt\": {\n      \"description\": \"customfield_11615\"\n    },\n    \"OriginalEndDate\": {\n      \"description\": \"customfield_11618\"\n    },\n    \"ExecutionOrder\": {\n      \"description\": \"customfield_11319\"\n    },\n    \"ReportedSourceId\": {\n      \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n    },\n    \"ReportedSource\": {\n      \"description\": \"customfield_11352: { value: ReportedSource }\"\n    },\n    \"Labels\": {\n      \"description\": \"labels: [ Labels as csv ]\"\n    },\n    \"ResolutionMethod\": {\n      \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n    },\n    \"ResolutionDetail\": {\n      \"description\": \"customfield_11345\"\n    },\n    \"RequirementType\": {\n      \"description\": \"customfield_11901\"\n    },\n    \"LinkedTicket\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n    },\n    \"LinkedTicketType\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n    },\n    \"EstimatedHours\": {\n      \"description\": \"customfield_11601\"\n    },\n    \"ConstructionClassification\": {\n      \"description\": \"customfield_11622\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UpdateJiraIssue

\n
\n

Update a Jira Issue

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"TicketId\": {\n      \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\",\n      \"default\": \"\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"IncidentStatus\": {\n      \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n    },\n    \"IncidentStatusId\": {\n      \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n    },\n    \"Comment\": {\n      \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n    },\n    \"Resolution\": {\n      \"description\": \"Text describing the resolution (resolution)\"\n    },\n    \"Resolved\": {\n      \"description\": \"Date of resolution (resolutiondate)\"\n    },\n    \"PriorityId\": {\n      \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n    },\n    \"Subject\": {\n      \"description\": \"Title of the Jira issue (summary)\"\n    },\n    \"Description\": {\n      \"description\": \"Body of the Jira issue (description)\"\n    },\n    \"InformerId\": {\n      \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n    },\n    \"Informer\": {\n      \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n    },\n    \"InformerKey\": {\n      \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n    },\n    \"ResponsibleId\": {\n      \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n    },\n    \"Responsible\": {\n      \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n    },\n    \"ResponsibleKey\": {\n      \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n    },\n    \"CreatorId\": {\n      \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n    },\n    \"Creator\": {\n      \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n    },\n    \"CreatorKey\": {\n      \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n    },\n    \"Impact\": {\n      \"description\": \"customfield_10500\"\n    },\n    \"Phone\": {\n      \"description\": \"customfield_12803\"\n    },\n    \"Urgency\": {\n      \"description\": \"customfield_10501\"\n    },\n    \"Classification\": {\n      \"description\": \"customfield_11396\"\n    },\n    \"ApplicantId\": {\n      \"description\": \"customfield_12900\"\n    },\n    \"ApplicantOrganization\": {\n      \"description\": \"customfield_11614\"\n    },\n    \"City\": {\n      \"description\": \"customfield_12804\"\n    },\n    \"FirstName\": {\n      \"description\": \"customfield_11365\"\n    },\n    \"WaitTime\": {\n      \"description\": \"customfield_11110\"\n    },\n    \"TicketTypeId\": {\n      \"description\": \"customfield_11349: { id: TicketTypeId }\"\n    },\n    \"TicketType\": {\n      \"description\": \"customfield_11349: { value: TicketType }\"\n    },\n    \"Email\": {\n      \"description\": \"customfield_11333\"\n    },\n    \"Provider\": {\n      \"description\": \"customfield_11332\"\n    },\n    \"ApprovalStatus\": {\n      \"description\": \"customfield_11325\"\n    },\n    \"ClosingReason\": {\n      \"description\": \"customfield_11320\"\n    },\n    \"AssignedGroup\": {\n      \"description\": \"customfield_11310\"\n    },\n    \"Sla\": {\n      \"description\": \"customfield_11312\"\n    },\n    \"Product\": {\n      \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n    },\n    \"Product1\": {\n      \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n    },\n    \"Product2\": {\n      \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n    },\n    \"Product3\": {\n      \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n    },\n    \"ActionId\": {\n      \"description\": \"customfield_11308: { id: ActionId }\"\n    },\n    \"Action\": {\n      \"description\": \"customfield_11308:  { value: Action }\"\n    },\n    \"SupportOrganizationId\": {\n      \"description\": \"customfield_11309: { id: OrganizationId }\"\n    },\n    \"SupportOrganization\": {\n      \"description\": \"customfield_11309: { value: Organization }\"\n    },\n    \"SubSupportOrganizationId\": {\n      \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n    },\n    \"SubSupportOrganization\": {\n      \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n    },\n    \"RequestType\": {\n      \"description\": \"customfield_11302\"\n    },\n    \"ProviderNumber\": {\n      \"description\": \"customfield_11403\"\n    },\n    \"Process\": {\n      \"description\": \"customfield_11607\"\n    },\n    \"AssociatedChange\": {\n      \"description\": \"customfield_11606\"\n    },\n    \"Authorizer\": {\n      \"description\": \"customfield_11390\"\n    },\n    \"AmountChangesEnd\": {\n      \"description\": \"customfield_11619\"\n    },\n    \"AmountChangesTime\": {\n      \"description\": \"customfield_11620\"\n    },\n    \"AmountReopen\": {\n      \"description\": \"customfield_11317\"\n    },\n    \"ChangeCause\": {\n      \"description\": \"customfield_11908\"\n    },\n    \"ApproverQuery\": {\n      \"description\": \"customfield_11823\"\n    },\n    \"ApproverQueryURL\": {\n      \"description\": \"customfield_11820\"\n    },\n    \"ScheduledFinishAt\": {\n      \"description\": \"customfield_11359\"\n    },\n    \"ScheduledStartAt\": {\n      \"description\": \"customfield_11386\"\n    },\n    \"SubTask\": {\n      \"description\": \"subtasks\"\n    },\n    \"RequirementAction\": {\n      \"description\": \"customfield_11608\"\n    },\n    \"Department\": {\n      \"description\": \"customfield_11328\"\n    },\n    \"Company\": {\n      \"description\": \"customfield_11327\"\n    },\n    \"TargetStartAt\": {\n      \"description\": \"customfield_11602\"\n    },\n    \"TargetFinishAt\": {\n      \"description\": \"customfield_11615\"\n    },\n    \"OriginalEndDate\": {\n      \"description\": \"customfield_11618\"\n    },\n    \"ExecutionOrder\": {\n      \"description\": \"customfield_11319\"\n    },\n    \"ReportedSourceId\": {\n      \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n    },\n    \"ReportedSource\": {\n      \"description\": \"customfield_11352: { value: ReportedSource }\"\n    },\n    \"Labels\": {\n      \"description\": \"labels: [ Labels as csv ]\"\n    },\n    \"ResolutionMethod\": {\n      \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n    },\n    \"ResolutionDetail\": {\n      \"description\": \"customfield_11345\"\n    },\n    \"RequirementType\": {\n      \"description\": \"customfield_11901\"\n    },\n    \"LinkedTicket\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n    },\n    \"LinkedTicketType\": {\n      \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n

Area Other

\n
\n
\n

CallFE_NBI

\n
\n

Call FE NBI functions

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"function\": {\n      \"description\": \"name of the function to call\"\n    },\n    \"arguments\": {\n      \"description\": \"arguments for the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

CallFE_RPA

\n
\n

Call FE RPA functions

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"function\": {\n      \"description\": \"name of the function to call\"\n    },\n    \"arguments\": {\n      \"description\": \"arguments for the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

CallSDE

\n
\n

Call SDE functions

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"function\": {\n      \"description\": \"name of the function to call\"\n    },\n    \"arguments\": {\n      \"description\": \"arguments for the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

ConnectorNDB

\n
\n

execute script to query the NDB

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Site\": {\n      \"description\": \"Site parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

isHoliday

\n
\n

Query to check if the current date (or the date optional in input) is an Holiday day or not

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"ruotaRep\": {\n      \"description\": \"ruotaRep parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {\n    \"checkDate\": {\n      \"description\": \"checkDate parameter\"\n    }\n  },\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

SendMailFromServer

\n
\n

run a script that sends an email

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Subject\": {\n      \"description\": \"Subject parameter\"\n    },\n    \"Content\": {\n      \"description\": \"Content parameter\"\n    },\n    \"Receiver\": {\n      \"description\": \"Receiver parameter\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UME_BoardPowerON

\n
\n

Call UME_BoardPowerON function

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Input\": {\n      \"description\": \"json passed to the the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UME_EnablePA

\n
\n

Call UME_EnablePA function

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Input\": {\n      \"description\": \"json passed to the the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UME_GetProductCode

\n
\n

Call UME_GetProductCode function

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Input\": {\n      \"description\": \"json passed to the the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UME_NodeRestart

\n
\n

Call UME_NodeRestart function

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Input\": {\n      \"description\": \"json passed to the the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n

UME_RestartBoard

\n
\n

Call UME_RestartBoard function

\n
\n
\nParameters:\n
\n
\n
\n
{\n  \"ogit/Automation/mandatoryParameters\": {\n    \"Input\": {\n      \"description\": \"json passed to the the function\"\n    }\n  },\n  \"ogit/Automation/optionalParameters\": {},\n  \"ogit/Automation/resultParameters\": {}\n}
\n
\n
\n
\n
\n
\n
\n
","document":{"main":"List of available capabilities","title":"List of available capabilities","subtitle":""},"fields":{"toc":true,"location":["documentation","integration","Capabilities","capabilities_list"]}},"sidebarYaml":{"id":"6d066bdd-c982-5a69-b909-a31e6fc044e0","showIndex":null}},"pageContext":{"id":"0865f012-163e-5023-970d-40d9b33fc153","parent":"documentation"}},"staticQueryHashes":["1010459453","1010459453","2356112386","2356112386","2603905930","2603905930","3026652197","3026652197","3167850324","3167850324","63159454","63159454"]}