Beschikbaar sandboxeindpunt
Laatst bijgewerkt: 16 juli 2024
Gemaakt voor:
- Ontwikkelaar
In tegenstelling tot andere eindpunten die in Sandbox API worden verstrekt, is dit eindpunt beschikbaar voor alle gebruikers, met inbegrip van die zonder de toegangstoestemmingen van het Beleid Sandbox.
U kunt een lijst maken van de sandboxen die beschikbaar zijn voor de huidige gebruiker door een GET-aanvraag in te dienen bij het beschikbare sandboxeindpunt.
API formaat
GET /{QUERY_PARAMS}
Parameter | Beschrijving |
---|---|
{QUERY_PARAMS} | Optionele queryparameters om resultaten te filteren op. Zie het bijlage documentvoor een lijst van beschikbare parameters. |
Verzoek
curl -X GET \
https://platform.adobe.io/data/foundation/sandbox-management/?limit=3&offset=1 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
Reactie
Een succesvol antwoord retourneert een lijst met sandboxen die beschikbaar zijn voor de huidige gebruiker, inclusief details zoals name
, title
, state
en type
.
{
"sandboxes": [
{
"name": "prod",
"title": "Production",
"state": "active",
"type": "production",
"region": "VA7",
"isDefault": true,
"eTag": 2,
"createdDate": "2019-09-04 04:57:24",
"lastModifiedDate": "2019-09-04 04:57:24",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
},
{
"name": "dev",
"title": "Development",
"state": "active",
"type": "development",
"region": "VA7",
"isDefault": false,
"eTag": 1,
"createdDate": "2019-09-03 22:27:48",
"lastModifiedDate": "2019-09-03 22:27:48",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
},
{
"name": "stage",
"title": "Staging",
"state": "active",
"type": "development",
"region": "VA7",
"isDefault": false,
"eTag": 1,
"createdDate": "2019-09-03 22:27:48",
"lastModifiedDate": "2019-09-03 22:27:48",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
}
],
"_page": {
"limit": 3,
"count": 1
},
"_links": {
"page": {
"href": "https://platform.adobe.io:443/data/foundation/sandbox-management/?limit={limit}&offset={offset}",
"templated": true
}
}
}
Eigenschap | Beschrijving |
---|---|
name | De naam van de sandbox. Wordt gebruikt voor opzoekdoeleinden in API-aanroepen. |
title | De weergavenaam voor de sandbox. |
state |
De huidige verwerkingsstatus van de sandbox. De status van een sandbox kan een van de volgende zijn:
|
type | Het type sandbox, 'development' of 'production'. |
isDefault | Een Booleaanse eigenschap die aangeeft of deze sandbox de standaardproductiesandbox voor de organisatie is. |
eTag | Een id voor een specifieke versie van de sandbox. Deze waarde wordt gebruikt voor versiebeheer en caching-efficiƫntie en wordt telkens bijgewerkt wanneer een wijziging in de sandbox wordt aangebracht. |
recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42