Client de correctifs

Client de correctifs #

Met à jour un ensemble spécifique de propriétés d'un client. Cela utilise le bouton JSON Format du correctif pour tout changement.

PATCH /v1.0/customers/{CUSTOMER_TENANT_ID}

Exemple #

Cette demande mettra à jour la clé API du PBX connexion et l'activer.

Demande # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : garder en vie
[ {
		« op » : « remplacer »,
		« chemin » : « /activé »,
		« value » : false
	}, {
		« op » : « remplacer »,
		« chemin » : « /pbxConnectionProfile/apiKey »,
		« value » : « newapikey »
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": false
	}, {
		"op": "replace",
		"path": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json; charset=utf-8
Longueur du contenu : xx
Request-Context : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Erreurs #

Non autorisé #

Lorsque le jeton n'est pas fourni, invalide ou expiré 

HTTP/1.1 401 Non autorisé

Mauvaise demande (1) #

Lorsque l'identifiant du locataire fourni n'est pas dans le bon format 

HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 149
{
	« error » : 400,
	« message » : « La valeur '<tenant id>' n'est pas valide.
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Mauvaise demande (2) #

Lorsque vous tentez de corriger une propriété non valide. 

HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 149
{
	« error » : 400,
	« message » : « L'emplacement cible spécifié par le segment de chemin '<invalid property>' n'a pas été trouvé.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Non trouvé #

Lorsqu'il n'y a pas de clients qui ont un identifiant de locataire correspondant 

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 95
{
	« error » : 404,
	« message » : « Introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}