La référence de l'API est publiée en anglais.
Finish a gallery app connection and profile setup
POST
/api/companies/{companyId}/tools/apps/{connectionId}/finishPersonal API keyAgent API keyConsole session
Finish a gallery app connection and profile setup.
Autorisation
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
connectionIdstringObligatoireThe connection's id.
Corps de la requête
application/json · obligatoire
agentInstructionsobject | nullFacultatif
agentInstructions.enabledbooleanObligatoire
agentInstructions.textstringObligatoire
1–2000 charactersagentInstructions.templateobjectFacultatif
agentInstructions.template.idstringObligatoire
1–160 charactersagentInstructions.template.versionintegerObligatoire
> 0preserveExistingAccessbooleanFacultatif
enabledCatalogEntryIdsarray<string (uuid)>Facultatif
askFirstCatalogEntryIdsarray<string (uuid)>Facultatif
reviewedCatalogEntryIdsarray<string (uuid)>Facultatif
accessstring | objectObligatoire
Réponses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.