CoreService

<back to all web services

StartActionAssignment

Actions - Operations

Start a custom action

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/action-assignments/{Id}/startStart a custom action
POST/action-assignments/{Id}/startStart a custom action
StartActionAssignment Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYes
TenantNameheaderstringYes
ParametersbodyarrayYes
ForcebodyboolNoWhether to execute the action even if it's already running
SendNotificationsbodyboolNoInform users when the job has finished
ParameterDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ValueformstringNoValue in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
DefaultformstringNoOptional default value for the frontend. Needs to be in the same format as the value
OptionalformboolNoOptional parameters do not need to have a value. Default -> Optional=false
TypeformParameterValueTypeNoThe data type of the value and default property
ValidationformstringNo
ParameterValueType Enum:
String
Number
Boolean
SecureString
JobDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe id of the job
TenantIdformGuidNoThe id of the tenant
NameformstringYesThe name of the job
ObjectTypeformObjectTypesNo
MessageformstringNoAn additional message
SelfLinkformstringYesApi link pointing to this object
ConfigItemIdformGuid?NoThe id of the configitem the job belongs to
ConfigItemTypeformObjectTypes?NoThe type of the configitem the job belongs to
JobTypeformJobTypesNoThe job type
StateformJobStatesNoThe current state of the job
StartTimeformDateTimeNoThe timestamp, when the job got started
EndTimeformDateTime?NoThe timestamp, when the job has finished
DurationformintNoThe duration (in seconds) of the job
WorkflowIdformstringNoThe id of the related workflow
SchedulerIdformstringNoThe id of the related scheduled task
ProgressformdoubleNoThe jobs progress in percent (0...100)
ConfigformDictionary<string, Object>YesContains various infos about the job
CreatedformDateTimeNoThe time the job was created
CreateUserformstringYesThe user the job was created with
CreateUserIdformstringYesThe user id the job was created with
CreateUserEmailformstringYesThe user email the job was created with
ModifiedformDateTimeNoThe time the job was last modified
ModifyUserformstringYesThe user the job was modified with
ModifyUserIdformstringYesThe user id the job was modified with
IsDeletedformboolNoTrue if the job is deleted
DeletedformDateTime?NoThe time the job was deleted
DeleteUserformstringNoThe user the job was deleted with
DeleteUserIdformstringNoThe user id the job was deleted with
SendNotificationsformboolNoWill be evaluated by event endpoints
IsRunningformboolNoTrue if it is in any of the 'running' states
NeedsAttentionformboolNoJobs with failed JobEvents are marked with NeedsAttention
ObjectTypes Enum:
None
ConfigItem
Tenant
Collection
Resource
ComputeNode
VirtualMachine
PhysicalMachine
Disk
Subnet
IPAddress
Job
JobEvent
FreezePeriod
ResourceGroup
Deployment
ResourceGroupTemplate
DeploymentTemplate
ResourceProvider
GenericResource
Role
Permission
User
PatchingWindow
Update
ReportDefinition
TimeSeries
DataPoint
Action
ActionAssignment
UserNote
JobTypes Enum:
Create
Update
Delete
Start
Stop
Restart
Backup
Restore
Patch
Action
JobStates Enum:
Pending
Starting
Running
Suspended
Stopping
Completed
Failed

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/action-assignments/{Id}/start HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","tenantName":"String","parameters":null,"force":false,"sendNotifications":false,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"Job","message":"String","selfLink":"String","configItemId":"00000000-0000-0000-0000-000000000000","configItemType":"None","jobType":"Create","state":"Pending","startTime":"0001-01-01T00:00:00.0000000Z","endTime":"0001-01-01T00:00:00.0000000Z","duration":0,"workflowId":"String","schedulerId":"String","progress":0,"config":{"String":{}},"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","createUserEmail":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","sendNotifications":false,"isRunning":false,"needsAttention":false}