HIRO Developer Portal
{
"ogit/Automation/mandatoryParameters": {},
"ogit/Automation/optionalParameters": {
"dataRange": {
"description": "dataRange"
},
"title": {
"description": "title"
},
"queryType": {
"description": "queryType",
"default": "TYPE_GENERAL"
},
"groupBys": {
"description": "groupBys",
"default": "FILTER_ADVERTISER_CURRENCY"
},
"filters": {
"description": "filters"
},
"metrics": {
"description": "metrics"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}Table of Contents
- Overview of application areas:
- Area Advertising
- DBM-Create-Query
- DBM-Download-Report
- DBM-Get-Query
- DBM-Run-Query
- DV360-Check-Updated-InsertionOrders
- DV360-Check-Updated-LineItems
- DV360-Create-and-Import-InsertionOrder
- DV360-Create-and-Import-LineItem
- DV360-Import-Advertiser-by-Id
- DV360-Import-Advertisers-by-Partner
- DV360-Import-InsertionOrder-by-Id
- DV360-Import-InsertionOrders-by-Advertiser
- DV360-Import-LineItem-by-Id
- DV360-Import-LineItems-by-InsertionOrder
- DV360-Patch-InsertionOrder
- DV360-Patch-LineItem
- TTD-Check-Updated-AdGroups
- TTD-Check-Updated-Campaigns
- TTD-Create-AdGroup
- TTD-Create-BidList
- TTD-Create-Campaign
- TTD-Download-Report
- TTD-Get-Query
- TTD-Import-AdGroup-by-Id
- TTD-Import-Advertiser-by-Id
- TTD-Import-Advertisers-by-Partner
- TTD-Import-BidList-by-Id
- TTD-Import-Campaign-by-Id
- TTD-Import-Campaigns-by-Id
- TTD-Patch-AdGroup
- TTD-Patch-Campaign
- TTD-Run-Query
- Area Analytics
- Area Generic
- Area IT Service Management (ITSM)
- Area SAP
- Area Ticket Systems
- Area Other
In HIRO™ you can use action handlers to performs activities in other
applications and systems. Available commands are specified as Capabilities in
the HIRO™ platform. In the list below you can find the specified capabilities,
sorted by application area.
Overview of application areas:
Area Advertising
DBM-Create-Query
Create Query in DBM
Parameters:
DBM-Download-Report
Download Report from DBM
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"linkLatestReport": {
"description": "Link to the latest report"
},
"target_xid": {
"description": "Xid of node to put the report into"
}
},
"ogit/Automation/optionalParameters": {
"startTimeMs": {
"description": "startTimeMs",
"default": ""
}
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DBM-Get-Query
Get Query from DBM
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"queryId": {
"description": "Id of query"
}
},
"ogit/Automation/optionalParameters": {
"startTimeMs": {
"description": "startTimeMs",
"default": ""
}
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DBM-Run-Query
Run Query in DBM
Parameters:
{
"ogit/Automation/mandatoryParameters": {},
"ogit/Automation/optionalParameters": {
"dataRange": {
"description": "dataRange"
},
"startTimeMs": {
"description": "startTimeMs",
"default": ""
},
"endTimeMs": {
"description": "endTimeMs",
"default": ""
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Check-Updated-InsertionOrders
Check Updated InsertionOrders from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
}
},
"ogit/Automation/optionalParameters": {
"filter": {
"description": "filter for request",
"default": "entityStatus= \"ENTITY_STATUS_ACTIVE\""
},
"lastUpdate": {
"description": "Timestamp of last update"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Check-Updated-LineItems
Check Updated LineItems from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"insertionOrderId": {
"description": "id of insertionOrder"
}
},
"ogit/Automation/optionalParameters": {
"filter": {
"description": "filter for request",
"default": "entityStatus= \"ENTITY_STATUS_ACTIVE\""
},
"lastUpdate": {
"description": "Timestamp of last update"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Create-and-Import-InsertionOrder
Create and import InsertionOrder from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"campaignId": {
"description": "id of campaign"
}
},
"ogit/Automation/optionalParameters": {
"displayName": {
"description": "displayName"
},
"entityStatus": {
"description": "entityStatus",
"default": "ENTITY_STATUS_DRAFT"
},
"pacingPeriod": {
"description": "pacingPeriod"
},
"pacingType": {
"description": "pacingType"
},
"timeUnit": {
"description": "timeUnit"
},
"timeUnitCount": {
"description": "timeUnitCount"
},
"maxImpressions": {
"description": "maxImpressions"
},
"performanceGoalType": {
"description": "performanceGoalType"
},
"performanceGoalAmountMicros": {
"description": "performanceGoalAmountMicros"
},
"budgetUnit": {
"description": "budgetUnit"
},
"budgetAmountMicros": {
"description": "budgetAmountMicros"
},
"startDate": {
"description": "startDate"
},
"endDate": {
"description": "endDate"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Create-and-Import-LineItem
Create and import LineItem from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"insertionOrderId": {
"description": "id of insertionOrder"
}
},
"ogit/Automation/optionalParameters": {
"displayName": {
"description": "displayName"
},
"lineItemType": {
"description": "lineItemType"
},
"entityStatus": {
"description": "entityStatus",
"default": "ENTITY_STATUS_DRAFT"
},
"flightDateType": {
"description": "flightDateType"
},
"startDate": {
"description": "startDate"
},
"endDate": {
"description": "endDate"
},
"budgetAllocationType": {
"description": "budgetAllocationType"
},
"maxAmount": {
"description": "maxAmount"
},
"pacingPeriod": {
"description": "pacingPeriod"
},
"pacingType": {
"description": "pacingType"
},
"timeUnit": {
"description": "timeUnit"
},
"timeUnitCount": {
"description": "timeUnitCount"
},
"maxImpressions": {
"description": "maxImpressions"
},
"markupType": {
"description": "markupType"
},
"markupAmount": {
"description": "markupAmount"
},
"budgetAmountMicros": {
"description": "budgetAmountMicros"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-Advertiser-by-Id
Import Advertiser by Id from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-Advertisers-by-Partner
Import Advertisers by Partner from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"partnerId": {
"description": "id of partner"
}
},
"ogit/Automation/optionalParameters": {
"filter": {
"description": "filter for request",
"default": "entityStatus= \"ENTITY_STATUS_ACTIVE\""
},
"fields": {
"description": "fields for request"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-InsertionOrder-by-Id
Import InsertionOrder by Id from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"insertionOrderId": {
"description": "id of insertionOrder"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-InsertionOrders-by-Advertiser
Import InsertionOrders by Advertiser from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
}
},
"ogit/Automation/optionalParameters": {
"filter": {
"description": "filter for request",
"default": "entityStatus= \"ENTITY_STATUS_ACTIVE\""
},
"fields": {
"description": "fields for request"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-LineItem-by-Id
Import LineItem by Id from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"lineItemId": {
"description": "id of lineItem"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Import-LineItems-by-InsertionOrder
Import LineItems by InsertionOrder from DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"insertionOrderId": {
"description": "id of insertionOrder"
}
},
"ogit/Automation/optionalParameters": {
"filter": {
"description": "filter for request",
"default": "entityStatus= \"ENTITY_STATUS_ACTIVE\""
},
"fields": {
"description": "fields for request"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Patch-InsertionOrder
Patch InsertionOrder in DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"insertionOrderId": {
"description": "id of insertionOrder"
}
},
"ogit/Automation/optionalParameters": {
"xid": {
"description": "xid"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}DV360-Patch-LineItem
Patch LineItem in DV360
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"advertiserId": {
"description": "id of advertiser"
},
"lineItemId": {
"description": "id of lineItem"
}
},
"ogit/Automation/optionalParameters": {
"xid": {
"description": "xid"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Check-Updated-AdGroups
Check Updated AdGroups in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"CampaignId": {
"description": "id of campaign"
}
},
"ogit/Automation/optionalParameters": {
"LastChangeTrackingVersion": {
"description": "LastChangeTrackingVersion"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Check-Updated-Campaigns
Check Updated Campaigns from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"AdvertiserId": {
"description": "id of advertiser"
}
},
"ogit/Automation/optionalParameters": {
"LastChangeTrackingVersion": {
"description": "LastChangeTrackingVersion"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Create-AdGroup
Create AdGroup in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"CampaignId": {
"description": "CampaignId"
},
"AdGroupName": {
"description": "AdGroupName"
}
},
"ogit/Automation/optionalParameters": {
"IsEnabled": {
"description": "IsEnabled"
},
"IsHighFillRate": {
"description": "IsHighFillRate"
},
"IndustryCategoryId": {
"description": "IndustryCategoryId"
},
"CurrencyCode": {
"description": "CurrencyCode"
},
"Budget": {
"description": "Budget"
},
"BudgetInImpressions": {
"description": "BudgetInImpressions"
},
"DailyBudget": {
"description": "DailyBudget"
},
"DailyBudgetInImpressions": {
"description": "DailyBudgetInImpressions"
},
"PacingMode": {
"description": "PacingMode"
},
"AutoAllocatorPriority": {
"description": "AutoAllocatorPriority"
},
"BaseBidCPM": {
"description": "BaseBidCPM"
},
"MaxBidCPM": {
"description": "MaxBidCPM"
},
"Description": {
"description": "Description"
},
"Availability": {
"description": "Availability"
},
"PredictiveClearingEnabled": {
"description": "PredictiveClearingEnabled"
},
"CreativeId": {
"description": "CreativeId"
},
"BidListId": {
"description": "BidListId"
},
"IsClassic": {
"description": "IsClassic"
},
"AudienceId": {
"description": "AudienceId"
},
"FrequencyCap": {
"description": "FrequencyCap"
},
"FrequencyPeriodInMinutes": {
"description": "FrequencyPeriodInMinutes"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Create-BidList
Create BidList in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Name": {
"description": "Name of BidList"
},
"BidListAdjustmentType": {
"description": "BidListAdjustmentType"
},
"BidListOwner": {
"description": "BidListOwner"
},
"BidListOwnerId": {
"description": "BidListOwnerId"
},
"ResolutionType": {
"description": "ResolutionType"
},
"IsAvailableForLibraryUse": {
"description": "IsAvailableForLibraryUse"
},
"BidLines": {
"description": "BidLines"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Create-Campaign
Create Campaigns in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"AdvertiserId": {
"description": "AdvertiserId"
},
"CampaignName": {
"description": "CampaignName"
}
},
"ogit/Automation/optionalParameters": {
"AutoallocatorEnabled": {
"description": "AutoallocatorEnabled"
},
"AutoPrioritizationEnabled": {
"description": "AutoPrioritizationEnabled"
},
"PacingMode": {
"description": "PacingMode"
},
"StartDate": {
"description": "StartDate"
},
"EndDate": {
"description": "EndDate"
},
"Budget": {
"description": "Budget"
},
"CurrencyCode": {
"description": "CurrencyCode"
},
"BudgetInImpressions": {
"description": "BudgetInImpressions"
},
"DailyBudget": {
"description": "DailyBudget"
},
"DailyBudgetInImpressions": {
"description": "DailyBudgetInImpressions"
},
"CampaignType": {
"description": "CampaignType"
},
"Description": {
"description": "Description"
},
"CustomLabelId": {
"description": "CustomLabelId"
},
"Availability": {
"description": "Availability"
},
"PartnerCostPercentageFee": {
"description": "PartnerCostPercentageFee"
},
"PurchaseOrderNumber": {
"description": "PurchaseOrderNumber"
},
"TimeZone": {
"description": "TimeZone"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Download-Report
Download Report from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"target_xid": {
"description": "The ogit\/_xid of the target vertex for the report."
},
"DownloadURI": {
"description": "URI in Tradedesk to download the report from."
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Get-Query
Get Query in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"ReportScheduleIds": {
"description": "The Schedule IDs of Report Executions to retrieve."
},
"AdvertiserIds": {
"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."
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-AdGroup-by-Id
Import AdGroup by Id from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"AdgroupIdList": {
"description": "id of adgroup"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-Advertiser-by-Id
Import Advertiser by Id from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"AdvertiserIdList": {
"description": "id or list of ids of advertisers"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-Advertisers-by-Partner
Import Advertisers by Partner from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {},
"ogit/Automation/optionalParameters": {
"PartnerId": {
"description": "id of partner"
},
"Availabilities": {
"description": "the Availabilities"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-BidList-by-Id
Import BidList By Id in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"BidListId": {
"description": "id of BidList"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-Campaign-by-Id
Import Campaigns by Id from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"CampaignIdList": {
"description": "id or list of ids of campaigns"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Import-Campaigns-by-Id
Import Campaigns by Id from TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"CampaignId": {
"description": "id of campaign"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Patch-AdGroup
Patch AdGroup
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"xid": {
"description": "The XID of the campaign"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Patch-Campaign
Patch Campaign
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"xid": {
"description": "ogit\/_xid of the associated vertex"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}TTD-Run-Query
Run Query in TradeDesk
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"ReportTemplateId": {
"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."
},
"ReportScheduleName": {
"description": "The name of the Report Schedule."
},
"ReportDateRange": {
"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."
}
},
"ogit/Automation/optionalParameters": {
"CampaignFilters": {
"description": "The list of campaigns on which to filter the report. Exactly one of PartnerFilters, AdvertiserFilters, CampaignFilters or AdGroupFilters must be set.",
"default": ""
},
"AdGroupFilters": {
"description": "The list of ad groups on which to filter the report.",
"default": ""
},
"ReportFileFormat": {
"description": "The file format for the report.",
"default": "CSV"
},
"ReportFrequency": {
"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.",
"default": "Once"
},
"ReportDateFormat": {
"description": "The format used for dates.",
"default": "Sortable"
},
"ReportNumericFormat": {
"description": "The format used for numeric values.",
"default": "US"
},
"TimeZone": {
"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\".",
"default": "UTC"
},
"IncludeHeaders": {
"description": "Whether or not to include column headers in the report. Only valid for Text reports.",
"default": "true"
},
"timeout": {
"description": "HTTP request timeout",
"default": 300000
}
},
"ogit/Automation/resultParameters": {}
}Area Analytics
ClassifierPredict
Request prediction for training model
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"classifier_name": {
"description": "Name of prediction model"
},
"input_string": {
"description": "The value for which the category should be calculated"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "Request timeout",
"default": 3000
}
},
"ogit/Automation/resultParameters": {
"exitcode": {
"description": "exit status of command (0 is success)"
},
"category": {
"description": "The predicted category"
},
"probability": {
"description": "The confidence level of prediction"
}
}
}ClassifierTrain
Send train request
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"trainingdata_id": {
"description": "ogit\/_id of ogit\/ML\/TrainedModel"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "Request timeout",
"default": 3000
}
},
"ogit/Automation/resultParameters": {
"exitcode": {
"description": "exit status of command (0 is success)"
},
"message": {
"description": "Training response message"
}
}
}Area Generic
AskApprove
Ask approve to process the issue
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"user_email": {
"description": "User's email to ask"
},
"issue_id": {
"description": "processing issue id"
},
"question_model": {
"description": "Special question model to generate a question"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "HTTP request timeout",
"default": 10000
}
},
"ogit/Automation/resultParameters": {}
}CSVtoSpreadsheet
Convert csv to spreadsheet
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"sourceId": {
"description": "ogit\/_id of the ogit\/Attachment that contains the CSV blob"
}
},
"ogit/Automation/optionalParameters": {
"keys": {
"description": "Identifier if keys are represented by rows or columns",
"default": "row"
},
"colOffset": {
"description": "Offset columns of the table. Entries before the offset are ignored.",
"default": "0"
},
"rowOffset": {
"description": "Offset rows of the table. Entries before the offset are ignored.",
"default": "0"
},
"delimiter": {
"description": "Delimiting character",
"default": ","
},
"targetXid": {
"description": "ogit\/_xid of the node where the result is to be stored",
"default": ""
},
"timeout": {
"description": "HTTP request timeout",
"default": 10000
}
},
"ogit/Automation/resultParameters": {}
}DateConverter
Converts a date from an initial format to another
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"date_string": {
"description": "date_string parameter"
}
},
"ogit/Automation/optionalParameters": {
"in_format": {
"description": "in_format parameter"
},
"out_format": {
"description": "out_format parameter"
}
},
"ogit/Automation/resultParameters": {}
}HTTPRequest
Make HTTP request
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"url": {
"description": "Request URL"
}
},
"ogit/Automation/optionalParameters": {
"method": {
"description": "HTTP request type (GET,POST,PUT,DELETE)",
"default": "GET"
},
"body": {
"description": "Body to send for post requests",
"default": ""
},
"headers": {
"description": "Headers to send",
"default": "Content-Type= application\/json"
},
"timeout": {
"description": "HTTP request timeout",
"default": 10000
},
"certname":
{
"description": "Name of the client certificate to use",
"default": ""
},
"username":
{
"description": "Username for basic auth",
"default": ""
},
"password":
{
"description": "Password for basic auth",
"default": ""
},
"oauth": {
"description": "Identifier of an OAuth configuration set",
"default": ""
},
"allow_insecure_https": {
"description": "Allow unverified SSL connections",
"default": "false"
}
},
"ogit/Automation/resultParameters": {
"body": {
"description": "HTTP result body"
},
"code": {
"description": "HTTP response code"
},
"headers": {
"description": "HTTP response headers"
}
}
}SendEmail
Send an email with KI
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"from": {
"description": "Who sends an email"
},
"to": {
"description": "Who is a receiver"
},
"subject": {
"description": "Subject of an email"
},
"body": {
"description": "Body of an email"
}
},
"ogit/Automation/optionalParameters": {
"type": {
"description": "Type of the content pain or html",
"default": "plain"
},
"cc": {
"description": "cc receivers",
"default": ""
},
"bcc": {
"description": "bcc receivers",
"default": ""
},
"timeout": {
"description": "HTTP request timeout",
"default": 10000
}
},
"ogit/Automation/resultParameters": {}
}SMSConnector
API to send SMS messages
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Arguments": {
"description": "Arguments parameter"
}
},
"ogit/Automation/optionalParameters": {
"issue": {
"description": "issue parameter"
}
},
"ogit/Automation/resultParameters": {}
}SOAPRequest
execute soap call on remote host
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"SOAPRequest": {
"description": "soap request payload"
},
"SOAPEndpoint": {
"description": "endpoint url of soap service"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}Area IT Service Management (ITSM)
AWXExecuteJobTemplate
Execute a JobTemplate in AWX
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"templateName": {
"description": "templateName"
},
"hostname": {
"description": "hostname"
},
"taskId": {
"description": "taskId"
}
},
"ogit/Automation/optionalParameters": {
"extraVariables": {
"description": "extraVariables",
"default": "{}"
}
},
"ogit/Automation/resultParameters": {}
}ExecuteCommand
execute a command on a remote host
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"command": {
"description": "command to execute"
}
},
"ogit/Automation/optionalParameters": {
"host": {
"description": "hostname to execute command on",
"default": ""
},
"user": {
"description": "user to run the command as",
"default": ""
},
"timeout": {
"description": "timeout in seconds",
"default": "120"
}
},
"ogit/Automation/resultParameters": {}
}ExecuteLocalCommand
ExecuteLocalCommand
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Command": {
"description": "Command parameter"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "timeout parameter"
}
},
"ogit/Automation/resultParameters": {}
}ExecuteMysqlQueryCq
Execute Mysql Queries
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"query": {
"description": "Query string that will be execute on the Mysql DB"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "SHH request timeout",
"default": 10000
}
},
"ogit/Automation/resultParameters": {}
}ExecuteOracleQueryCq
Execute Oracle Queries
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"query": {
"description": "Query string that will be execute on the Oracle DB"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "SHH request timeout",
"default": 10000
}
},
"ogit/Automation/resultParameters": {}
}ExecuteWindowsCommand
Executes command over PS-Remoting on Windows endpoint
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"host": {
"description": "Target endpoint Windows system"
},
"command_type": {
"description": "Type of command CMD or PowerShell"
},
"command": {
"description": "Cmdlet name or command"
},
"arguments": {
"description": "Space-separated list of command arguments"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}GetVMInfo
Retrieves information about a specific VM
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"vmname": {
"description": "vmname"
},
"vcenter": {
"description": "vcenter"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}RunLocalScript
RunLocalScript
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Command": {
"description": "Command"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}RunScript
this one executes scripts
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"command": {
"description": "script to run"
}
},
"ogit/Automation/optionalParameters": {
"timeout": {
"description": "timeout in seconds",
"default": "120"
},
"workdir": {
"description": "working directory for the script",
"default": "\/tmp"
}
},
"ogit/Automation/resultParameters": {}
}SelfMonitoringExecution
run script on remote host
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Command": {
"description": "script to execute"
},
"Hostname": {
"description": "host to execute script on"
}
},
"ogit/Automation/optionalParameters": {
"User": {
"description": "target user"
},
"SshOpts": {
"description": "SSH options"
}
},
"ogit/Automation/resultParameters": {}
}CalculateNoOfSecondsBetweenDates
calculate the number of seconds between two dates
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"endDate": {
"description": "endDate parameter"
},
"currentDate": {
"description": "currentDate parameter"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}Area SAP
SAPAutomatizaStringSet
Query AutomatizaStringSet from SAP
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"I_Trax": {
"description": "I_Trax",
"default": ""
},
"I_Vista": {
"description": "I_Vista",
"default": ""
},
"I_Batch": {
"description": "I_Batch",
"default": ""
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}SAPQueryOtSet
Query OT data set from SAP
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"QueryOtSet1": {
"description": "First parameter of QueryOtSet",
"default": "ot"
},
"QueryOtSet2": {
"description": "Second parameter of QueryOtSet",
"default": ""
},
"QueryOtSet3": {
"description": "Third parameter of QueryOtSet",
"default": "break"
},
"QueryOtSet4": {
"description": "Fourth parameter of QueryOtSet",
"default": "0"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}SAPQuerySet
Query data set from SAP
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"TabQuerySet": {
"description": "JSON structure for the SAP query",
"default": ""
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}SAPRequest
Request an SAP Remote Function Call (RFC) execution
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"function": {
"description": "Remote Function Call (RFC)"
}
},
"ogit/Automation/optionalParameters": {
"destination": {
"description": "SAP destination",
"default": ""
},
"parameters": {
"description": "Parameters for the RFC",
"default": "{}"
}
},
"ogit/Automation/resultParameters": {}
}SAPUserGetDetail
Get the details of a user in SAP
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"SID": {
"description": "SID"
},
"CLIENT": {
"description": "CLIENT"
},
"USER": {
"description": "USER"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}SAPUserUnlock
Unlock a user in SAP
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"SID": {
"description": "SID"
},
"CLIENT": {
"description": "CLIENT"
},
"USER": {
"description": "USER"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}Area Ticket Systems
CreateJiraIssue
Create a Jira Issue
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Project": {
"description": "Unique id of the Jira project for the new issue (project: {key: Project})",
"default": ""
},
"IncidentType": {
"description": "Id of the type of issue to be created in Jira (issuetype: {name: IncidentType})",
"default": ""
},
"Subject": {
"description": "Title of the Jira issue (summary)",
"default": ""
},
"Description": {
"description": "Body of the Jira issue (description)",
"default": ""
}
},
"ogit/Automation/optionalParameters": {
"IncidentStatus": {
"description": "Name of a status for an issue (status: {name: IncidentStatus}}"
},
"IncidentStatusId": {
"description": "Id number of a status for an issue (status: {id: IncidentStatusId}}"
},
"PriorityId": {
"description": "Id number of a Jira priority (priority: {id: PriorityId}}"
},
"InformerId": {
"description": "Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})"
},
"Informer": {
"description": "Set issue reporter via name of a Jira user (reporter: {name: Informer})"
},
"InformerKey": {
"description": "Set issue reporter via key of a Jira user (reporter: {key: InformerKey})"
},
"ResponsibleId": {
"description": "Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}"
},
"Responsible": {
"description": "Set issue assignee via name of a Jira user (assignee: {name: Responsible}}"
},
"ResponsibleKey": {
"description": "Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}"
},
"CreatorId": {
"description": "Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}"
},
"Creator": {
"description": "Set issue creator via name of a Jira user (creator: {name: Creator}}"
},
"CreatorKey": {
"description": "Set issue creator via key of a Jira user (creator: {key: CreatorKey}}"
},
"TicketKey": {
"description": "Key of the type of Jira issue (issuekey: {key: TicketKey})"
},
"Comment": {
"description": "Add a comment to the issue (comment: {add: {body: Comment}}}"
},
"Impact": {
"description": "customfield_10500"
},
"Phone": {
"description": "customfield_12803"
},
"Urgency": {
"description": "customfield_10501"
},
"Classification": {
"description": "customfield_11396"
},
"ApplicantId": {
"description": "customfield_12900"
},
"ApplicantOrganization": {
"description": "customfield_11614"
},
"City": {
"description": "customfield_12804"
},
"FirstName": {
"description": "customfield_11365"
},
"WaitTime": {
"description": "customfield_11110"
},
"TicketTypeId": {
"description": "customfield_11349: { id: TicketTypeId }"
},
"TicketType": {
"description": "customfield_11349: { value: TicketType }"
},
"Email": {
"description": "customfield_11333"
},
"Provider": {
"description": "customfield_11332"
},
"ApprovalStatus": {
"description": "customfield_11325"
},
"ClosingReason": {
"description": "customfield_11320"
},
"AssignedGroup": {
"description": "customfield_11310"
},
"Sla": {
"description": "customfield_11312"
},
"Product": {
"description": "customfield_11307: [ { value: Product }, ... ]"
},
"Product1": {
"description": "customfield_11307: [ { value: Product1 }, ... ]"
},
"Product2": {
"description": "customfield_11307: [ { value: Product2 }, ... ]"
},
"Product3": {
"description": "customfield_11307: [ { value: Product3 }, ... ]"
},
"ActionId": {
"description": "customfield_11308: { id: ActionId }"
},
"Action": {
"description": "customfield_11308: { value: Action }"
},
"SupportOrganizationId": {
"description": "customfield_11309: { id: OrganizationId }"
},
"SupportOrganization": {
"description": "customfield_11309: { value: Organization }"
},
"SubSupportOrganizationId": {
"description": "customfield_11309: { child: { id: SubOrganizationId } }"
},
"SubSupportOrganization": {
"description": "customfield_11309: { child: { value: SubOrganization } }"
},
"RequestType": {
"description": "customfield_11302"
},
"ProviderNumber": {
"description": "customfield_11403"
},
"Process": {
"description": "customfield_11607"
},
"AssociatedChange": {
"description": "customfield_11606"
},
"Authorizer": {
"description": "customfield_11390"
},
"AmountChangesEnd": {
"description": "customfield_11619"
},
"AmountChangesTime": {
"description": "customfield_11620"
},
"AmountReopen": {
"description": "customfield_11317"
},
"ChangeCause": {
"description": "customfield_11908"
},
"ApproverQuery": {
"description": "customfield_11823"
},
"ApproverQueryURL": {
"description": "customfield_11820"
},
"ScheduledFinishAt": {
"description": "customfield_11359"
},
"ScheduledStartAt": {
"description": "customfield_11386"
},
"SubTask": {
"description": "subtasks"
},
"RequirementAction": {
"description": "customfield_11608"
},
"Department": {
"description": "customfield_11328"
},
"Company": {
"description": "customfield_11327"
},
"TargetStartAt": {
"description": "customfield_11602"
},
"TargetFinishAt": {
"description": "customfield_11615"
},
"OriginalEndDate": {
"description": "customfield_11618"
},
"ExecutionOrder": {
"description": "customfield_11319"
},
"ReportedSourceId": {
"description": "customfield_11352: { id: ReportedSourceId }"
},
"ReportedSource": {
"description": "customfield_11352: { value: ReportedSource }"
},
"Labels": {
"description": "labels: [ Labels as csv ]"
},
"ResolutionMethod": {
"description": "customfield_11344: { value: ResolutionMethod }"
},
"ResolutionDetail": {
"description": "customfield_11345"
},
"RequirementType": {
"description": "customfield_11901"
},
"LinkedTicket": {
"description": "issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}"
},
"LinkedTicketType": {
"description": "issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}"
},
"TransportOrder": {
"description": "customfield_11398"
}
},
"ogit/Automation/resultParameters": {}
}OMCreateRequest
Create Operations Manager Request
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"antragsart": {
"description": ""
},
"database": {
"description": ""
},
"server": {
"description": ""
},
"url": {
"description": ""
}
},
"ogit/Automation/optionalParameters": {
"parameters": {
"description": "additional parameters",
"default": ""
},
"environment": {
"description": "environment of target systems",
"default": ""
}
},
"ogit/Automation/resultParameters": {}
}OMGetRequestStatus
Get the status of an Operations Manager Request
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"requestid": {
"description": "id of the OM request to query"
},
"database": {
"description": ""
},
"server": {
"description": ""
},
"url": {
"description": ""
}
},
"ogit/Automation/optionalParameters": {
"environment": {
"description": "environment of the target systems",
"default": ""
}
},
"ogit/Automation/resultParameters": {}
}RemedyAddWorklog
Add a Worklog entry to a ticket in Remedy
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"remedyId": {
"description": "remedyId"
},
"message": {
"description": "message"
}
},
"ogit/Automation/optionalParameters": {
"viewAccess": {
"description": "viewAccess",
"default": "Public"
}
},
"ogit/Automation/resultParameters": {}
}RemedyGetTicket
Get ticket from remedy
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"remedyId": {
"description": "remedyId"
}
},
"ogit/Automation/optionalParameters": {
"env": {
"description": "which environment to connect to? (PROD\/DEV)",
"default": "PROD"
}
},
"ogit/Automation/resultParameters": {}
}RemedySetAssignee
Set Assignee of a ticket in Remedy
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"remedyId": {
"description": "remedyId"
},
"assignee": {
"description": "assignee"
},
"assigneeLoginId": {
"description": "assigneeLoginId"
},
"message": {
"description": "message"
}
},
"ogit/Automation/optionalParameters": {
"hiroProcessed": {
"description": "issueId",
"default": "Yes"
}
},
"ogit/Automation/resultParameters": {}
}RemedySetStatus
Change Status of a ticket in Remedy
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"remedyId": {
"description": "remedyId"
},
"status": {
"description": "status"
}
},
"ogit/Automation/optionalParameters": {
"statusReason": {
"description": "statusReason",
"default": ""
},
"resolution": {
"description": "resolution",
"default": ""
}
},
"ogit/Automation/resultParameters": {}
}TransistJiraIssue
Transist a Jira Issue to a new state. This is also used to resolve a ticket.
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"TicketId": {
"description": "Key of the type of Jira issue (issuekey: {key: TicketKey})",
"default": ""
},
"TransitionId": {
"description": "Id of the transition state that this ticket shall move to. (transition: {id: TransitionId}})",
"default": ""
}
},
"ogit/Automation/optionalParameters": {
"IncidentStatus": {
"description": "Name of a status for an issue (status: {name: IncidentStatus}}"
},
"IncidentStatusId": {
"description": "Id number of a status for an issue (status: {id: IncidentStatusId}}"
},
"Comment": {
"description": "Add a comment to the issue (comment: {add: {body: Comment}}}"
},
"Resolution": {
"description": "Text describing the resolution (resolution)"
},
"Resolved": {
"description": "Date of resolution (resolutiondate)"
},
"PriorityId": {
"description": "Id number of a Jira priority (priority: {id: PriorityId}}"
},
"Subject": {
"description": "Title of the Jira issue (summary)"
},
"Description": {
"description": "Body of the Jira issue (description)"
},
"InformerId": {
"description": "Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})"
},
"Informer": {
"description": "Set issue reporter via name of a Jira user (reporter: {name: Informer})"
},
"InformerKey": {
"description": "Set issue reporter via key of a Jira user (reporter: {key: InformerKey})"
},
"ResponsibleId": {
"description": "Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}"
},
"Responsible": {
"description": "Set issue assignee via name of a Jira user (assignee: {name: Responsible}}"
},
"ResponsibleKey": {
"description": "Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}"
},
"CreatorId": {
"description": "Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}"
},
"Creator": {
"description": "Set issue creator via name of a Jira user (creator: {name: Creator}}"
},
"CreatorKey": {
"description": "Set issue creator via key of a Jira user (creator: {key: CreatorKey}}"
},
"Impact": {
"description": "customfield_10500"
},
"Phone": {
"description": "customfield_12803"
},
"Urgency": {
"description": "customfield_10501"
},
"Classification": {
"description": "customfield_11396"
},
"ApplicantId": {
"description": "customfield_12900"
},
"ApplicantOrganization": {
"description": "customfield_11614"
},
"City": {
"description": "customfield_12804"
},
"FirstName": {
"description": "customfield_11365"
},
"WaitTime": {
"description": "customfield_11110"
},
"TicketTypeId": {
"description": "customfield_11349: { id: TicketTypeId }"
},
"TicketType": {
"description": "customfield_11349: { value: TicketType }"
},
"Email": {
"description": "customfield_11333"
},
"Provider": {
"description": "customfield_11332"
},
"ApprovalStatus": {
"description": "customfield_11325"
},
"ClosingReason": {
"description": "customfield_11320"
},
"AssignedGroup": {
"description": "customfield_11310"
},
"Sla": {
"description": "customfield_11312"
},
"Product": {
"description": "customfield_11307: [ { value: Product }, ... ]"
},
"Product1": {
"description": "customfield_11307: [ { value: Product1 }, ... ]"
},
"Product2": {
"description": "customfield_11307: [ { value: Product2 }, ... ]"
},
"Product3": {
"description": "customfield_11307: [ { value: Product3 }, ... ]"
},
"ActionId": {
"description": "customfield_11308: { id: ActionId }"
},
"Action": {
"description": "customfield_11308: { value: Action }"
},
"SupportOrganizationId": {
"description": "customfield_11309: { id: OrganizationId }"
},
"SupportOrganization": {
"description": "customfield_11309: { value: Organization }"
},
"SubSupportOrganizationId": {
"description": "customfield_11309: { child: { id: SubOrganizationId } }"
},
"SubSupportOrganization": {
"description": "customfield_11309: { child: { value: SubOrganization } }"
},
"RequestType": {
"description": "customfield_11302"
},
"ProviderNumber": {
"description": "customfield_11403"
},
"Process": {
"description": "customfield_11607"
},
"AssociatedChange": {
"description": "customfield_11606"
},
"Authorizer": {
"description": "customfield_11390"
},
"AmountChangesEnd": {
"description": "customfield_11619"
},
"AmountChangesTime": {
"description": "customfield_11620"
},
"AmountReopen": {
"description": "customfield_11317"
},
"ChangeCause": {
"description": "customfield_11908"
},
"ApproverQuery": {
"description": "customfield_11823"
},
"ApproverQueryURL": {
"description": "customfield_11820"
},
"ScheduledFinishAt": {
"description": "customfield_11359"
},
"ScheduledStartAt": {
"description": "customfield_11386"
},
"SubTask": {
"description": "subtasks"
},
"RequirementAction": {
"description": "customfield_11608"
},
"Department": {
"description": "customfield_11328"
},
"Company": {
"description": "customfield_11327"
},
"TargetStartAt": {
"description": "customfield_11602"
},
"TargetFinishAt": {
"description": "customfield_11615"
},
"OriginalEndDate": {
"description": "customfield_11618"
},
"ExecutionOrder": {
"description": "customfield_11319"
},
"ReportedSourceId": {
"description": "customfield_11352: { id: ReportedSourceId }"
},
"ReportedSource": {
"description": "customfield_11352: { value: ReportedSource }"
},
"Labels": {
"description": "labels: [ Labels as csv ]"
},
"ResolutionMethod": {
"description": "customfield_11344: { value: ResolutionMethod }"
},
"ResolutionDetail": {
"description": "customfield_11345"
},
"RequirementType": {
"description": "customfield_11901"
},
"LinkedTicket": {
"description": "issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}"
},
"LinkedTicketType": {
"description": "issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}"
},
"EstimatedHours": {
"description": "customfield_11601"
},
"ConstructionClassification": {
"description": "customfield_11622"
}
},
"ogit/Automation/resultParameters": {}
}UpdateJiraIssue
Update a Jira Issue
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"TicketId": {
"description": "Key of the type of Jira issue (issuekey: {key: TicketKey})",
"default": ""
}
},
"ogit/Automation/optionalParameters": {
"IncidentStatus": {
"description": "Name of a status for an issue (status: {name: IncidentStatus}}"
},
"IncidentStatusId": {
"description": "Id number of a status for an issue (status: {id: IncidentStatusId}}"
},
"Comment": {
"description": "Add a comment to the issue (comment: {add: {body: Comment}}}"
},
"Resolution": {
"description": "Text describing the resolution (resolution)"
},
"Resolved": {
"description": "Date of resolution (resolutiondate)"
},
"PriorityId": {
"description": "Id number of a Jira priority (priority: {id: PriorityId}}"
},
"Subject": {
"description": "Title of the Jira issue (summary)"
},
"Description": {
"description": "Body of the Jira issue (description)"
},
"InformerId": {
"description": "Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})"
},
"Informer": {
"description": "Set issue reporter via name of a Jira user (reporter: {name: Informer})"
},
"InformerKey": {
"description": "Set issue reporter via key of a Jira user (reporter: {key: InformerKey})"
},
"ResponsibleId": {
"description": "Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}"
},
"Responsible": {
"description": "Set issue assignee via name of a Jira user (assignee: {name: Responsible}}"
},
"ResponsibleKey": {
"description": "Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}"
},
"CreatorId": {
"description": "Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}"
},
"Creator": {
"description": "Set issue creator via name of a Jira user (creator: {name: Creator}}"
},
"CreatorKey": {
"description": "Set issue creator via key of a Jira user (creator: {key: CreatorKey}}"
},
"Impact": {
"description": "customfield_10500"
},
"Phone": {
"description": "customfield_12803"
},
"Urgency": {
"description": "customfield_10501"
},
"Classification": {
"description": "customfield_11396"
},
"ApplicantId": {
"description": "customfield_12900"
},
"ApplicantOrganization": {
"description": "customfield_11614"
},
"City": {
"description": "customfield_12804"
},
"FirstName": {
"description": "customfield_11365"
},
"WaitTime": {
"description": "customfield_11110"
},
"TicketTypeId": {
"description": "customfield_11349: { id: TicketTypeId }"
},
"TicketType": {
"description": "customfield_11349: { value: TicketType }"
},
"Email": {
"description": "customfield_11333"
},
"Provider": {
"description": "customfield_11332"
},
"ApprovalStatus": {
"description": "customfield_11325"
},
"ClosingReason": {
"description": "customfield_11320"
},
"AssignedGroup": {
"description": "customfield_11310"
},
"Sla": {
"description": "customfield_11312"
},
"Product": {
"description": "customfield_11307: [ { value: Product }, ... ]"
},
"Product1": {
"description": "customfield_11307: [ { value: Product1 }, ... ]"
},
"Product2": {
"description": "customfield_11307: [ { value: Product2 }, ... ]"
},
"Product3": {
"description": "customfield_11307: [ { value: Product3 }, ... ]"
},
"ActionId": {
"description": "customfield_11308: { id: ActionId }"
},
"Action": {
"description": "customfield_11308: { value: Action }"
},
"SupportOrganizationId": {
"description": "customfield_11309: { id: OrganizationId }"
},
"SupportOrganization": {
"description": "customfield_11309: { value: Organization }"
},
"SubSupportOrganizationId": {
"description": "customfield_11309: { child: { id: SubOrganizationId } }"
},
"SubSupportOrganization": {
"description": "customfield_11309: { child: { value: SubOrganization } }"
},
"RequestType": {
"description": "customfield_11302"
},
"ProviderNumber": {
"description": "customfield_11403"
},
"Process": {
"description": "customfield_11607"
},
"AssociatedChange": {
"description": "customfield_11606"
},
"Authorizer": {
"description": "customfield_11390"
},
"AmountChangesEnd": {
"description": "customfield_11619"
},
"AmountChangesTime": {
"description": "customfield_11620"
},
"AmountReopen": {
"description": "customfield_11317"
},
"ChangeCause": {
"description": "customfield_11908"
},
"ApproverQuery": {
"description": "customfield_11823"
},
"ApproverQueryURL": {
"description": "customfield_11820"
},
"ScheduledFinishAt": {
"description": "customfield_11359"
},
"ScheduledStartAt": {
"description": "customfield_11386"
},
"SubTask": {
"description": "subtasks"
},
"RequirementAction": {
"description": "customfield_11608"
},
"Department": {
"description": "customfield_11328"
},
"Company": {
"description": "customfield_11327"
},
"TargetStartAt": {
"description": "customfield_11602"
},
"TargetFinishAt": {
"description": "customfield_11615"
},
"OriginalEndDate": {
"description": "customfield_11618"
},
"ExecutionOrder": {
"description": "customfield_11319"
},
"ReportedSourceId": {
"description": "customfield_11352: { id: ReportedSourceId }"
},
"ReportedSource": {
"description": "customfield_11352: { value: ReportedSource }"
},
"Labels": {
"description": "labels: [ Labels as csv ]"
},
"ResolutionMethod": {
"description": "customfield_11344: { value: ResolutionMethod }"
},
"ResolutionDetail": {
"description": "customfield_11345"
},
"RequirementType": {
"description": "customfield_11901"
},
"LinkedTicket": {
"description": "issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}"
},
"LinkedTicketType": {
"description": "issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}"
}
},
"ogit/Automation/resultParameters": {}
}Area Other
CallFE_NBI
Call FE NBI functions
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"function": {
"description": "name of the function to call"
},
"arguments": {
"description": "arguments for the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}CallFE_RPA
Call FE RPA functions
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"function": {
"description": "name of the function to call"
},
"arguments": {
"description": "arguments for the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}CallSDE
Call SDE functions
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"function": {
"description": "name of the function to call"
},
"arguments": {
"description": "arguments for the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}ConnectorNDB
execute script to query the NDB
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Site": {
"description": "Site parameter"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}isHoliday
Query to check if the current date (or the date optional in input) is an Holiday day or not
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"ruotaRep": {
"description": "ruotaRep parameter"
}
},
"ogit/Automation/optionalParameters": {
"checkDate": {
"description": "checkDate parameter"
}
},
"ogit/Automation/resultParameters": {}
}SendMailFromServer
run a script that sends an email
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Subject": {
"description": "Subject parameter"
},
"Content": {
"description": "Content parameter"
},
"Receiver": {
"description": "Receiver parameter"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}UME_BoardPowerON
Call UME_BoardPowerON function
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Input": {
"description": "json passed to the the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}UME_EnablePA
Call UME_EnablePA function
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Input": {
"description": "json passed to the the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}UME_GetProductCode
Call UME_GetProductCode function
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Input": {
"description": "json passed to the the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}UME_NodeRestart
Call UME_NodeRestart function
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Input": {
"description": "json passed to the the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}UME_RestartBoard
Call UME_RestartBoard function
Parameters:
{
"ogit/Automation/mandatoryParameters": {
"Input": {
"description": "json passed to the the function"
}
},
"ogit/Automation/optionalParameters": {},
"ogit/Automation/resultParameters": {}
}