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.

Deletes a single broadcast by its ID.

Prev Next
Delete
/api/v{version}/broadcasts/{broadcastId}
Security
OAuth

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 parameters
x-correlationToken
string
x-clientId
string

The external ID of the client.

Min length0
Max length128
x-onBehalfOf
string
Min length0
Max length24
api-version
string
Path parameters
broadcastId
stringRequired

The ID of the broadcast to delete.

Min length0
Max length128
version
stringRequired
Responses
200

OK

Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.ModifyBroadcastJson)
code
string | null
id
string | null
name
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.ModifyBroadcastJson)
code
string | null
id
string | null
name
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.ModifyBroadcastJson)
code
string | null
id
string | null
name
string | null
401

Unauthorized

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
404

Not Found

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500

Internal Server Error