Launches for Content Fragments API (2024.11-experimental)

Download OpenAPI specification:Download

List all Launches

This operation provides support for retrieving all the Content Fragments Launches accessible to the current user, determined via the applied request authorization. By default this call will return a maximum of 50 items. The caller can define other limits suited to their application (see the limit query parameter), but the limit cannot be higher than 50. To ask for the next set of items pass the value of the cursor provided in the response to the cursor query parameter.

SecurityBearer
Request
query Parameters
cursor
string (Cursor) non-empty

For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.

limit
integer <int32> (Limit) [ 1 .. 50 ]

For a paginated request, this parameter defines the maximum number of items to retrieve.

header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Responses
200

List of Launches.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

401

Unauthorized

403

Forbidden

406

Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Create a Launch
This operation creates a Launch, given the appropriate parameters.


SecurityBearer 
Request 
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
title
required
string  non-empty 
The title of the launch, as used for display purposes


 
isDeep
boolean
 Default:  true
This parameter specifies if the content fragment referenced by the sources should be part of the launch


 
sources
required
Array of strings (Path) 
This parameter is an array of content fragment paths and specifies the content that should be part of the launch.


 
liveDate
string <date-time> 
If this parameter is set along with the productionReady parameter, when the launch is promoted the launch's content fragments are also published to the live environment at the time specified by this parameter, and not immediately.


 
productionReady
boolean
 Default:  false
When the launch is marked as production ready, after a launch is promoted, the launch's content fragments are also published to the live environment.


 
Responses 
202
This is an asynchronous operation. Please follow the URL from the Location header to get the status of the job that creates the Launch.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


post/
Request samples 
application/json
{
  • "title": "LaunchTitle",
  • "isDeep": true,
  • "sources": [
    ]
}
Response samples 
application/problem+json
{}
Delete a Launch
This operation deletes a Launch, given the appropriate parameters. 
The ETag value required by the If-Match header must contain the value of the ETag header returned by the corresponding GET request.


SecurityBearer 
Request 
path Parameters
launchId
required
string
Id of the launch for which the operation is performed


 
header Parameters
If-Match
required
string
The If-Match header field makes the request method conditional on the recipient origin server either having at least
one current representation of the target resource, when the field value is "*", or having a current representation of
the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
202
Request to delete the launch was accepted. Use the Location header to get the status of the job that deletes the launch.


401
Unauthorized


403
Forbidden


404
Not Found


412
Precondition Failed


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


delete/{launchId}
Request samples 
Response samples 
application/problem+json
{}
Get a Launch
SecurityBearer 
Request 
path Parameters
launchId
required
string
Id of the launch for which the operation is performed


 
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
Launch found


304
Not Modified


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/{launchId}
Request samples 
Response samples 
application/json
{
  • "launchId": "string",
  • "path": "string",
  • "name": "string",
  • "title": "string",
  • "liveDate": "2019-08-24T14:15:22Z",
  • "productionReady": true,
  • "isDeep": true,
  • "modified": {
    },
  • "created": {
    },
  • "promoted": {
    }
}
Update properties of a Launch
This operation allows fully updating the properties of a Launch. The changes are passed as JSON.


Update requests should pass the most recent ETag value received from the server using the getLaunch or from this endpoint.


SecurityBearer 
Request 
path Parameters
launchId
required
string
Id of the launch for which the operation is performed


 
header Parameters
If-Match
required
string
The If-Match header field makes the request method conditional on the recipient origin server either having at least
one current representation of the target resource, when the field value is "*", or having a current representation of
the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
title
string  non-empty 
The title of the launch, as used for display purposes.


 
isDeep
boolean
This parameter specifies whether the content fragment referenced by the sources should be part of the launch.


 
liveDate
string <date-time> 
If this parameter is set along with the productionReady parameter, when the launch is promoted, the launch's content fragments are also published to the live environment at the time specified by this parameter, and not immediately.


 
productionReady
boolean
When the launch is marked as production ready, after a launch is promoted, the launch's content fragments are also published to the live environment.


 
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


412
Precondition Failed


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


428
Precondition Required


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


patch/{launchId}
Request samples 
application/json
{
  • "title": "string",
  • "isDeep": true,
  • "liveDate": "2019-08-24T14:15:22Z",
  • "productionReady": true
}
Response samples 
application/json
{
  • "launchId": "string",
  • "path": "string",
  • "name": "string",
  • "title": "string",
  • "liveDate": "2019-08-24T14:15:22Z",
  • "productionReady": true,
  • "isDeep": true,
  • "modified": {
    },
  • "created": {
    },
  • "promoted": {
    }
}
Get all sources of a Launch
This operation provides support for retrieving all the sources IDs that belong to the Launch. 
The ETag value that can be passed to the If-None-Match header must contain the value of the ETag header returned by the GET /launches/{launchId}  request.


SecurityBearer 
Request 
path Parameters
launchId
required
string <uuid>  (UUID) 
Id of the launch for which the operation is performed


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
query Parameters
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
limit
integer <int32>  (Limit)   [ 1 .. 50 ] 
For a paginated request, this parameter defines the maximum number of items to retrieve.


 
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
List of content fragment IDs that belong to the launch. The caller can define other limits suited to their application (see the limit query
parameter), but the limit cannot be higher than 50. To ask for the next set of items
pass the value of the cursor provided in the response to the cursor query parameter.


304
Not Modified


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/{launchId}/sources
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "self": {
    }
}
Edit a Launch's sources
This operation edits the sources of a Launch, given the appropriate parameters. 
The ETag value required by the If-Match header must contain the value of the ETag header returned by the GET /launches/{launchId} request.


SecurityBearer 
Request 
path Parameters
launchId
required
string <uuid>  (UUID) 
Id of the launch for which the operation is performed


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
header Parameters
If-Match
required
string
The If-Match header field makes the request method conditional on the recipient origin server either having at least
one current representation of the target resource, when the field value is "*", or having a current representation of
the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
sourcesToRemove
Array of strings <uuid>  (UUID) 
 
sourcesToAdd
Array of strings <uuid>  (UUID) 
 
Responses 
202
Request to edit the launch's sources was accepted. Use the Location header to get the status of the job that edits the launch.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


412
Precondition Failed


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


post/{launchId}/sources
Request samples 
application/json
{
  • "sourcesToRemove": [
    ],
  • "sourcesToAdd": [
    ]
}
Response samples 
application/problem+json
{}
Rebase a Launch
Perform a rebase of this Launch over the production sources or another Launch, depending on the provided parameters. 
The ETag value that can be passed to the If-Match header must contain the value of the ETag header returned by the GET /launches/{launchId}  request.


SecurityBearer 
Request 
path Parameters
launchId
required
string <uuid>  (UUID) 
Id of the launch for which the operation is performed.


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
header Parameters
If-Match
required
string
The If-Match header field makes the request method conditional on the recipient origin server either having at least
one current representation of the target resource, when the field value is "*", or having a current representation of
the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.


For more details, please head over to RFC9110.


 
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
compare
string <uuid> 
The target launch against which the operation should be performed. If not specified, the operation is performed against the production.


 
isDeep
boolean
 Default:  false
This parameter specifies if the content fragments that are transitively referenced by the content fragment sources should be part of the operation, otherwise only those fragments that are directly referenced in the sources will be included.


 
sources
Array of strings <uuid>  (UUID) 
The content fragments for which the operation should be performed. If not specified, then the operation is performed for all the content fragment sources in the launch.


 
Responses 
202
Request to perform Launch rebase was accepted.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


412
Precondition Failed


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


post/{launchId}/rebase
Request samples 
application/json
{
  • "compare": "5f6239bb-cfcb-4093-b184-f819bf433a5c",
  • "isDeep": false,
  • "sources": [
    ]
}
Response samples 
application/problem+json
{}
Promote a Launch
Perform a promote of this Launch to production or another Launch, depending on the provided parameters


SecurityBearer 
Request 
path Parameters
launchId
required
string <uuid>  (UUID) 
Id of the launch for which the operation is performed


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
compare
string <uuid> 
The target launch against which the operation should be performed. If not specified, the operation is performed against the production.


 
isDeep
boolean
 Default:  false
This parameter specifies if the content fragments that are transitively referenced by the content fragment sources should be part of the operation, otherwise only those fragments that are directly referenced in the sources will be included.


 
sources
Array of strings <uuid>  (UUID) 
The content fragments for which the operation should be performed. If not specified, then the operation is performed for all the content fragment sources in the launch.


 
Responses 
202
Request to perform Launch promote was accepted.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


post/{launchId}/promote
Request samples 
application/json
{
  • "compare": "5f6239bb-cfcb-4093-b184-f819bf433a5c",
  • "isDeep": false,
  • "sources": [
    ]
}
Response samples 
application/problem+json
{}
Compute differences
Compute the differences between Launch and the production or another Launch, depending on the provided parameters


SecurityBearer 
Request 
path Parameters
launchId
required
string <uuid>  (UUID) 
Id of the launch for which the operation is performed


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
compare
string <uuid> 
The target launch against which the operation should be performed. If not specified, the operation is performed against the production.


 
isDeep
boolean
 Default:  false
This parameter specifies if the content fragments that are transitively referenced by the content fragment sources should be part of the operation, otherwise only those fragments that are directly referenced in the sources will be included.


 
sources
Array of strings <uuid>  (UUID) 
The content fragments for which the operation should be performed. If not specified, then the operation is performed for all the content fragment sources in the launch.


 
Responses 
202
Request to compute Launch differences was accepted.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


post/{launchId}/diff
Request samples 
application/json
{
  • "compare": "5f6239bb-cfcb-4093-b184-f819bf433a5c",
  • "isDeep": false,
  • "sources": [
    ]
}
Response samples 
application/problem+json
{}
Get Job status
Get information about the processing of the job


SecurityBearer 
Request 
path Parameters
jobId
required
string
The id of the job.


 
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
Job is processing.


303
Job completed.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/jobs/{jobId}/status
Request samples 
Response samples 
application/json
{
  • "state": "ACTIVE"
}
Get the result of a processed job
SecurityBearer 
Request 
path Parameters
jobId
required
string
The id of the job.


 
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
Job completed.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


401
Unauthorized


403
Forbidden


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


415
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/jobs/{jobId}/result
Request samples 
Response samples 
{
  • "operation": "aem.launches.create",
  • "status": 200,
  • "description": "The job encountered an error during processing",
  • "data": {
    },
  • "errors": [
    ]
}