Search
K
Links

Release | Update release details

After creating a guidebook release, you can update attributes of the release.
You need GUIBO's internal unique identifier of the release to update it. It is the parameter "link" when fetching the release details:

a) Change the number of devices

patch
https://services.schneidergeo.com/content/release/{account}/{release}/devices/{devices}
Change numer of devices

b) Change start date of release period

patch
https://services.schneidergeo.com/content/release/{account}/{release}/start/{yyyy-MM-dd}
Change start date of release period

c) Change end date of release period

patch
https://services.schneidergeo.com/content/release/{account}/{release}/end/{yyyy-MM-dd}
Change end date of release period
delete
https://services.schneidergeo.com/content/contentreference/{bundle}/external/{customId}
Remove external assets after guidebook release
Parameters
Path
customId*
customId of the asset to be removed from guidebook
bundle*
link of the guidebook
Header
Authorization*
API key
Responses
200: OK
{ "message": "OK" }

e) Delete asset after guidebook release with customId

delete
https://services.schneidergeo.com/content/contentreference/{bundleId}/internal/{assetLink}
Remove internal assets after guidebook release

f) Add external assets after guidebook release

Request Params

{bundle} in the URL should be replaced with the actual guidebook link

Authentication

Replace the API token (e.g., xxxxxx-xxxxxxx-xxxxxxxx-xxxxxx) from Authorization header with your authorization code.

Request Body

The request body should be a JSON array containing objects, where each object represents an external asset to be imported into the Guidebook. Each asset should have the following attributes:
  • type (string): The type of data to import (e.g., "GEO").
  • externalId (string): The customID of the asset to import.
  • libraryExternalId (string): The customID of the library from which the assets should be imported.

Example cURL request for importing external assets:

curl --location 'https://services.schneidergeo.com/content/guidebook/{bundle}/import/external?type=automatic' \
--header 'Authorization: xxxxxx-xxxxxxx-xxxxxxxx-xxxxxx' \
--header 'Content-Type: application/json' \
--data ' [
{
"type": "GEO",
"externalId": "customId_1",
"libraryExternalId": "library customId"
},
{
"type": "GEO",
"externalId": "customId_2",
"libraryExternalId": "library customId"
}
]
'

Response

The API will respond with a status code indicating the success or failure of the import operation. The response body contain the referenceIDs of additional asset which are created.
  • Successful Response (HTTP Status 200): The data was successfully imported.
Example response
[
"C5DYxOAN"
]