orchestrator
2023.4
false
Important :
Veuillez noter que ce contenu a été localisé en partie à l’aide de la traduction automatique.
Guide de l'API Orchestrator
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 18 juin 2024

[Aperçu] Obtenir les paramètres

Utilisez ce point de terminaison pour récupérer la liste des paires clé-valeur pour les paramètres d'e-mail et d'authentification.

Point de terminaison de l’API

docs imagehttps://{yourDomain}/identity/api/Setting

Étendues

Nécessite les étendues suivantes :

  • PM.Setting
  • PM.Setting.Read

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Remarque : pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Paramètres de requête

Paramètre de requête

Type de données

Description

key

(facultatif)

Chaîne de caractères (string)

Saisissez le nom du paramètre que vous souhaitez récupérer.

Par exemple, pour récupérer le paramètre Domaine SMTP, saisissez key=Email.Smtp.Domain.

partitionGlobalId

(facultatif)

Chaîne de caractères (string)

L'ID de l'organisation pour laquelle vous souhaitez récupérer les paramètres.

userId

(facultatif)

Chaîne de caractères (string)

L'ID de l'utilisateur pour lequel vous souhaitez récupérer les paramètres.

Réponses

200 OK

Renvoie les comptes de robot interrogés.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

  • Votre {baseURL} est : https://{yourDomain}/{organizationName}/{tenantName}/
  • Votre {access_token} est : 1234 (pour des considérations de longueur).
  • Le {partitionGlobalId} est : magic-7
  • Vous souhaitez récupérer les paramètres de messagerie globaux, vous devez vous connecter en tant qu'administrateur hôte. Dans ce cas, vous ne fournissez pas de userID.

L’appel devrait ressembler à l'exemple ci-dessous (cURL) :

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&key=Email.Smtp.Domain&key=Email.Smtp.EnableSsl&key=Email.Smtp.FromDisplayName&key=Email.Smtp.FromEmail&key=Email.Smtp.Host&key=Email.Smtp.Password&key=Email.Smtp.Port&key=Email.Smtp.UseDefaultCredentials&key=Email.Smtp.UserName' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&key=Email.Smtp.Domain&key=Email.Smtp.EnableSsl&key=Email.Smtp.FromDisplayName&key=Email.Smtp.FromEmail&key=Email.Smtp.Host&key=Email.Smtp.Password&key=Email.Smtp.Port&key=Email.Smtp.UseDefaultCredentials&key=Email.Smtp.UserName' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Voici la réponse pour un appel réussi :

[
    {
        "id": 6,
        "key": "Email.Smtp.FromEmail",
        "value": "newalerts.uipath@gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 7,
        "key": "Email.Smtp.FromDisplayName",
        "value": "Hogwarts server - 21.10 - Clean",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 15,
        "key": "Email.Smtp.Domain",
        "value": "",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 16,
        "key": "Email.Smtp.EnableSsl",
        "value": "true",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 17,
        "key": "Email.Smtp.Port",
        "value": "587",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 18,
        "key": "Email.Smtp.UseDefaultCredentials",
        "value": "false",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 19,
        "key": "Email.Smtp.UserName",
        "value": "newalerts.uipath@gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 20,
        "key": "Email.Smtp.Host",
        "value": "smtp.gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 21,
        "key": "Email.Smtp.Password",
        "value": "protego-spell",
        "partitionGlobalId": "magic-7",
        "userId": null
    }
][
    {
        "id": 6,
        "key": "Email.Smtp.FromEmail",
        "value": "newalerts.uipath@gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 7,
        "key": "Email.Smtp.FromDisplayName",
        "value": "Hogwarts server - 21.10 - Clean",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 15,
        "key": "Email.Smtp.Domain",
        "value": "",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 16,
        "key": "Email.Smtp.EnableSsl",
        "value": "true",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 17,
        "key": "Email.Smtp.Port",
        "value": "587",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 18,
        "key": "Email.Smtp.UseDefaultCredentials",
        "value": "false",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 19,
        "key": "Email.Smtp.UserName",
        "value": "newalerts.uipath@gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 20,
        "key": "Email.Smtp.Host",
        "value": "smtp.gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 21,
        "key": "Email.Smtp.Password",
        "value": "protego-spell",
        "partitionGlobalId": "magic-7",
        "userId": null
    }
]
  • Point de terminaison de l’API
  • Étendues
  • En-têtes de requête.
  • Paramètres de requête
  • Réponses
  • 200 OK
  • Exemple de requête

Cette page vous a-t-elle été utile ?

Obtenez l'aide dont vous avez besoin
Formation RPA - Cours d'automatisation
Forum de la communauté UiPath
Uipath Logo White
Confiance et sécurité
© 2005-2024 UiPath Tous droits réservés.