Requêtes relatives aux actifs

Remarque :

Les ressources de texte globales et par robot prennent en charge jusqu’à 1 000 000 caractères.

Important :

• Les requêtes $filter renvoient le résultat d'un filtre personnalisé qui utilise les paramètres Nom et Description dans une fonction contains .

Récupération d'un actif spécifique

L'appel ci-dessous permet d'afficher toutes les informations disponibles de l'actif avec le nom DocAPITest et l'ID 455.

Obtenir

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}

Retrieving a specific asset by name

You can retrieve a specific asset by its name using the GetAssetByName endpoint. This is useful when you already know the asset name and want to fetch its value outside of an automation workflow.

Obtenir

/api/Assets/name/{name}/value

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur
X-UIPATH-OrganizationUnitId	ID de dossier

Exemple de requête

GET /api/Assets/name/Testing/value
Authorization: Bearer {access_token}
X-UIPATH-OrganizationUnitId: {folderId}

Codes de réponse

200 OK

Corps de la réponse

{
  "Name": "Testing",
  "ValueType": "Credential",
  "Value": "username: Testing",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "SecretValue": "",
  "CredentialUsername": "Testing",
  "CredentialPassword": "Testing",
  "ExternalName": null,
  "CredentialStoreId": 1,
  "KeyValueList": [],
  "ConnectionData": null,
  "Id": 1
}

Récupération par actifs de Robot

Pour effectuer une requête GET vers le point de terminaison /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(), vous devez fournir robotId et assetName dans l'URL. Notez que seul le nom d'utilisateur est renvoyé pour les actifs d'identifiants du Robot, comme vous le voyez dans l'exemple ci-dessous.

Obtenir

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}

Ajout d'un actif

L'exemple suivant permet de créer un actif global, de type texte.

Publier

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}