Get a composition's sub-composition IDs and names and their payload structures

To update graphics in a control app, you need their sub-composition IDs and payload structures.

There are two ways to get them:

• In Composer

• Using the API

Get a composition's sub-composition IDs and names and their payload structures in Composer

1. Open the app's composition in Composer. If the app is from a template and doesn't have an associated composition, you'll need to extract a composition from the app.

2. Navigate to the composition tree and click into each sub-composition you'd like to update.

3. In the lower right quadrant of Composer, click on the wrench icon to open a pop-up that shows the sub-composition's ID and payload structure.

   

   Getting a sub-composition ID in Composer

Get a composition's sub-composition IDs and names and their payload structures using the API

1. Get the API token for the particular app instance that contains the sub-composition ID and payload structure you're looking for.

2. Send a GET request to the endpoint for Get a control app's control data https://app.singular.live/apiv2/controlapps/:appToken/control replacing :appToken with the actual app token for the app instance.

3. In the response, locate subCompositionId and subCompositionName and the payload structure of each sub-composition you'd like to update.