---
title: "/api/admin/startexecutejob"
slug: "apiadminstartexecutejob-2"
updated: 2025-08-20T01:02:48Z
published: 2026-03-20T12:47:08Z
canonical: "docs.grassfish.com/apiadminstartexecutejob-2"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /api/admin/startexecutejob

Post/api/admin/startexecutejob

SecurityOAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
		

Header parametersx-correlationTokenstring
x-clientIdstringMin length0Max length128
x-onBehalfOfstringMin length0Max length24
api-versionstring

Body parameters<select class='api-response-data' aria-label='Media type'><option value='9d78773c-1bc3-4d8b-bf98-0b0eeaa39b1a'>application/json</option>
<option value='9e3534b7-3a61-4283-9da1-f0540681719c'>text/json</option>
<option value='5f02b1ea-6605-4279-90a5-066feacfcf3a'>application/*+json</option>
</select>object  jobNamestring   | null  
runNowboolean    
endpointIds Array of string  | null  string    
datestring  (date-time)   | null  
clientCodestring   | null  Min length0Max length22
playerCodestring   | null  Min length0Max length22
broadcastCodestring   | null  Min length0Max length96

object  jobNamestring   | null  
runNowboolean    
endpointIds Array of string  | null  string    
datestring  (date-time)   | null  
clientCodestring   | null  Min length0Max length22
playerCodestring   | null  Min length0Max length22
broadcastCodestring   | null  Min length0Max length96

object  jobNamestring   | null  
runNowboolean    
endpointIds Array of string  | null  string    
datestring  (date-time)   | null  
clientCodestring   | null  Min length0Max length22
playerCodestring   | null  Min length0Max length22
broadcastCodestring   | null  Min length0Max length96

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='c07aa137-830f-41ac-b45b-ce508cef6156'>text/plain</option>
<option value='61d49e6f-f5ad-4493-a5f5-23e749475ac7'>application/json</option>
<option value='4dcc7e73-4a5c-4a65-91ca-529082d00c20'>text/json</option>
</select>Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='de4afca7-684d-4f1f-8474-499a0d5b1af4'>text/plain</option>
<option value='ece8b9c5-54fb-4c15-9f70-2cf03e9a1e15'>application/json</option>
<option value='9103f9ef-caad-4a3b-94bc-6b2147ad883e'>text/json</option>
</select>object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

401

Unauthorized

403

Forbidden

<select class='api-response-data' aria-label='Media type'><option value='4f1aca52-278d-42d7-a416-304d2a7a74f1'>text/plain</option>
<option value='3a5a210e-d670-4770-92a7-dafb46b93e5e'>application/json</option>
<option value='8dc66bc2-b29e-435a-899f-29c2a2dde269'>text/json</option>
</select>object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

500

Internal Server Error

default

Error

<select class='api-response-data' aria-label='Media type'><option value='43cc3ac7-0a14-4680-8a6c-267b3458d6c4'>text/plain</option>
<option value='474d6281-9726-454b-bc3d-e32c787b5d81'>application/json</option>
<option value='f55bb459-7aa8-4fba-9a31-b75fb25848ae'>text/json</option>
</select>Expand Allobject  

Returns the result of a command execution.

successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  

Returns the result of a command execution.

successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  

Returns the result of a command execution.

successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null