Requêtes relatives aux paquets (Packages Requests)

Récupération de toutes les versions disponibles pour un paquet spécifique

Obtenir

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='QueueItemsProcessing')

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": "https://{yourDomain}/odata/$metadata#Processes",
  "@odata.count": 2,
 "value": [
        {
            "IsActive": true,
            "SupportsMultipleEntryPoints": false,
            "MainEntryPointPath": null,
            "RequiresUserInteraction": true,
            "TargetFramework": "Legacy",
            "Title": null,
            "Version": "1.0.6981.35861",
            "Key": "QueueItemsProcessing:1.0.6981.35861",
            "Description": "Process items from an Orchestrator queue.",
            "Published": "2021-07-23T16:40:07.793Z",
            "IsLatestVersion": false,
            "OldVersion": null,
            "ReleaseNotes": null,
            "Authors": "petrina.calota",
            "ProjectType": "Undefined",
            "Tags": null,
            "Id": "QueueItemsProcessing",
            "Arguments": {
                "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                "Output": null
            }
        }
    ]
}

Téléchargement d'une version de paquet spécifique

La requête ci-dessous vous permet de télécharger le package portant le nom « add_queue_items » et la version 1.0.6654.27080.

Obtenir

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Récupération des arguments d'un paquet

La requête GET suivante effectuée vers le point de terminaison /odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key') renvoie tous les arguments d'entrée et de sortie d'un paquet spécifique, leur type et s'ils ont une valeur par défaut. Les arguments d'entrée; de sortie ou d'entrée/de sortie d'un projet deviennent les paramètres d'entrée et de sortie dans Orchestrator.

Obtenir

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')

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": "https://{yourDomain}/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
    "Input": "[\r\n  {\r\n    \"name\": \"age\",\r\n    \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"Array\",\r\n    \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"trueOrFalse\",\r\n    \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"dateNow\",\r\n    \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"stringNew\",\r\n    \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"arrayStrings\",\r\n    \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"inOutTry\",\r\n    \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  }\r\n]",
    "Output": "[\r\n  {\r\n    \"name\": \"output\",\r\n    \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n  },\r\n  {\r\n    \"name\": \"inOutTry\",\r\n    \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n  }\r\n]"
}

Modification des paramètres au niveau du package

Il est possible de mettre à jour les paramètres d'entrée et de sortie d'un projet en effectuant une requête POST au point de terminaison /odata/Processes/UiPath.Server.Configuration.OData.SetArguments.

Remarque :

Cet appel remplace tous les paramètres précédents et offre la validation.

En outre, notez que ce point de terminaison permet de modifier les paramètres d'entrée et de sortie d'un paquet d'automatisation uniquement si vous ne l'avez pas téléchargé dans Orchestrator via l'API, la page Paquets (Packages) ou le flux NuGet.

Pour mettre à jour uniquement les valeurs des paramètres d'entrée, vous pouvez le faire au niveau des processus, au niveau des tâches et/ou au niveau des planifications.

Publier

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.SetArguments

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
  "key": "input_output_test:1.3.6",
  "arguments": {
    "Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]", 
    "Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
  }
}

Codes de réponse

200 OK

Récupération de paquets

Obtenir

https://{yourDomain}/odata/Processes

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": "https://{yourDomain}/odata/$metadata#Processes",
  "@odata.count": 2,
    "value": [
        {
            "IsActive": false,
            "SupportsMultipleEntryPoints": false,
            "MainEntryPointPath": null,
            "RequiresUserInteraction": true,
            "TargetFramework": "Legacy",
            "Title": null,
            "Version": "1.0.6981.35861",
            "Key": "QueueItemsProcessing:1.0.6981.35861",
            "Description": "Process items from an Orchestrator queue.",
            "Published": "2021-07-23T16:40:07.7933333Z",
            "IsLatestVersion": false,
            "OldVersion": null,
            "ReleaseNotes": null,
            "Authors": "petrina.calota",
            "ProjectType": "Undefined",
            "Tags": null,
            "Id": "QueueItemsProcessing",
            "Arguments": {
                "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                "Output": null
            }
        }
    ]
}