Services de forme d'objet de gestion de définition de travail
Les services suivants se trouvent sur la forme d'objet de gestion de définition de travail (PTC.SCA.SCO.WorkDefinitionManagementThingShape) :
Services de création
 |
Lors de la création d'un objet faisant partie du modèle de données du bloc de construction d'instructions de travail, la valeur de l'UID est générée automatiquement par le système. Toute valeur que vous entrez dans le champ UID est ignorée.
|
CreateExternalSystems : crée un ou plusieurs systèmes externes sur la base des informations ajoutées à la table de paramètres d'entrée ExternalSystems. Renvoie la liste des systèmes externes qui ont été créés, avec leur UID.
• Paramètres d'entrée : ExternalSystems (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionControlCharacteristicResponses : crée une ou plusieurs réponses de caractéristique de contrôle de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionControlCharacteristicResponses. Renvoie la liste des réponses de caractéristique de contrôle de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionControlCharacteristicResponses (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionControlCharacteristics : crée une ou plusieurs réponses de caractéristique de contrôle de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionControlCharacteristics. Renvoie la liste des caractéristiques de contrôle de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionControlCharacteristics (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionDependencies : crée une ou plusieurs dépendances de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionDependencies. Renvoie la liste des dépendances de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionDependencies (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionIllustrations : crée une ou plusieurs illustrations de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionIllustrations. Renvoie la liste des illustrations de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionIllustrations (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionLinks : crée un ou plusieurs liens de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionLinks. Renvoie la liste des liens de définition de travail qui ont été créés, avec leur UID.
• Paramètres d'entrée : WorkDefinitionLinks (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionMaterialSpecificationInstances : crée une ou plusieurs instances de spécification de matière de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecificationInstances. Renvoie la liste des instances de spécification de matière de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionMaterialSpecificationInstances (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionMaterialSpecificationLinks : crée des liens sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecificationLinks. Renvoie la liste des liens de spécification de matière de définition de travail qui ont été créés, avec leur UID.
• Paramètres d'entrée : WorkDefinitionMaterialSpecificationLinks (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionMaterialSpecifications : crée une ou plusieurs instances de spécification de matière de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecifications. Renvoie la liste des spécifications de matière de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionMaterialSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionMetadatas : crée une ou plusieurs entrées de métadonnées de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMetadatas. Renvoie la liste des entrées de métadonnées de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionMetadatas (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionPersonnelSpecifications : crée une ou plusieurs spécifications de personnel de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionPersonnelSpecifications. Renvoie la liste des spécifications de personnel de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionPersonnelSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionProcessingResourceSpecifications : crée une ou plusieurs spécifications de ressource de production de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionProcessingResourceSpecifications. Renvoie la liste des spécifications de ressource de production de définition de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitionProcessingResourceSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitionRelatedDocuments : crée un ou plusieurs documents connexes de définition de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionRelatedDocuments. Renvoie la liste des documents connexes de définition de travail qui ont été créés, avec leur UID.
• Paramètres d'entrée : WorkDefinitionRelatedDocuments (INFOTABLE)
• Sortie : result (INFOTABLE)
CreateWorkDefinitions : crée une ou plusieurs définitions de travail sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitions. Renvoie la liste des définitions de travail qui ont été créées, avec leur UID.
• Paramètres d'entrée : WorkDefinitions (INFOTABLE)
• Sortie : result (INFOTABLE)
Services de suppression
DeleteExternalSystem : supprime le système externe avec l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinition : supprime la définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionControlCharacteristic : supprime la caractéristique de contrôle de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionControlCharacteristicResponse : supprime la réponse de caractéristique de contrôle de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionDependency : supprime la dépendance de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionIllustration : supprime l'illustration de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionLink : supprime le lien de définition de travail associé à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionMaterialSpecification : supprime la spécification de matière de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionMaterialSpecificationInstance : supprime l'instance de spécification de matière de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionMaterialSpecificationLink : supprime les liens de spécification de matière de définition de travail associés à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionMetadata : supprime l'entrée de métadonnées de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionPersonnelSpecification : supprime la spécification de personnel de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionProcessingResourceSpecification : supprime la spécification de ressource de production de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
DeleteWorkDefinitionReleatedDocument : supprime le document connexe de définition de travail associé à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
Services de lecture
GetExternalSystem : récupère le système externe associé à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
GetExternalSystems : récupère une liste de tous les systèmes externes. Un filtre peut être appliqué avec un décalage et une limite pour affiner la liste des résultats renvoyés.
• Paramètres d'entrée :
◦ filter (STRING)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Sortie : result (INFOTABLE)
GetReferencingJobOrderWorkDefinitionLink : récupère le lien de l'ordre de travail vers la définition de travail, pour l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinition : récupère la définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionControlCharacteristicResponses : récupère la liste de toutes les réponses de caractéristique de contrôle de définition de travail associées à l'UID de caractéristique de contrôle de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionControlCharacteristicUID (STRING)
• Sortie : result (INFOTABLE : forme de données PTC.SCA.SCO.WorkDefinitionControlCharacteristicResponse)
GetWorkDefinitionControlCharacteristics : récupère la liste de toutes les caractéristiques de contrôle de définition de travail associées à la définition de travail ayant l'UID spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionDependencies : récupère la liste de toutes les dépendances de définition de travail associées à FromUID spécifié.
• Paramètres d'entrée : FromUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionDependers : récupère la liste de toutes les dépendances de définition de travail associées à ToUID spécifié.
• Paramètres d'entrée : ToUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionExecutionLog : récupère le journal des modifications du statut d'exécution pour la définition de travail spécifiée.
• Paramètres d'entrée :
◦ WorkDefinitionUID (STRING)
• Sortie : une table d'informations de la forme de données PTC.SCA.SCO.WorkDefinitionExecutionStatusHistory (INFOTABLE) ; format :
"TimeStamp", "StateUID", "StateName", "UserName"
GetWorkDefinitionExecutionSummary : récupère le récapitulatif de statut d'exécution pour la définition de travail spécifiée avec le temps total passé dans chaque statut d'exécution en secondes. Le temps de l'état actuel n'est calculé que si le marqueur d'inclusion spécifié est "true".
• Paramètres d'entrée :
◦ WorkDefinitionUID (STRING)
◦ IncludeCurrentStatus (BOOLEAN) : la valeur par défaut est définie sur faux.
• Sortie : une table d'informations de la forme de données PTC.SCA.SCO.WorkDefinitionExecutionStatusSummary (INFOTABLE) ; format :
"StateUID", "StateName", "TotalTime"
GetWorkDefinitionIllustrations : récupère la liste de toutes les illustrations de définition de travail associées à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : une table d'informations de la forme de données PTC.SCA.SCO.WorkDefinitioExecutionStatusHistory(INFOTABLE) ; format :
"TimeStamp", "StateUID", "StateName", "UserName"
GetWorkDefinitionLinks : récupère la liste de tous les liens de définition de travail associés à l'UID de parent spécifié.
• Paramètres d'entrée : ParentUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMaterialSpecification : récupère la spécification de matière de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMaterialSpecificationInstance : récupère l'instance de spécification de matière de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMaterialSpecificationInstances : récupère une liste de toutes les instances de spécification de matière de définition de travail associées à l'UID de spécification de matière de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionMaterialSpecificationUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMaterialSpecificationLinks : récupère la liste de tous les liens de spécification de matière de définition de travail associés à l'UID de parent spécifié.
• Paramètres d'entrée : ParentUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMaterialSpecifications : récupère la liste de toutes les spécifications de matière de définition de travail associées à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMetadata : récupère l'entrée de métadonnées de définition de travail associée à l'UID spécifié.
• Paramètres d'entrée : UID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionMetadatas : récupère la liste de toutes les entrées de métadonnées de définition de travail. Un filtre peut être appliqué avec un décalage et une limite pour affiner la liste des résultats renvoyés.
• Paramètres d'entrée :
◦ filter (STRING)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Sortie : result (INFOTABLE)
GetWorkDefinitionPersonnelSpecifications : récupère la liste de toutes les spécifications de personnel de définition de travail associées à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionProcessingResourceSpecifications : récupère la liste de toutes les spécifications de ressource de production de définition de travail associées à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitionRelatedDocuments : récupère la liste de tous les documents connexes de définition de travail associés à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
GetWorkDefinitions : récupère la liste de toutes les définitions de travail. Un filtre peut être appliqué avec un décalage et une limite pour affiner la liste des résultats renvoyés.
• Paramètres d'entrée :
◦ filter (STRING)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Sortie : result (INFOTABLE)
GetWorkDefinitionThumbnail : récupère l'image miniature associée à l'UID de définition de travail spécifié.
• Paramètres d'entrée : WorkDefinitionUID (STRING)
• Sortie : result (INFOTABLE)
Services de mise à jour
UpdateExternalSystems : met à jour un ou plusieurs systèmes externes par UID, sur la base des informations ajoutées à la table de paramètres d'entrée ExternalSystems. Renvoie la liste des systèmes externes qui ont été mis à jour.
• Paramètres d'entrée : ExternalSystems (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionControlCharacteristicResponses : met à jour une ou plusieurs réponses de caractéristique de contrôle de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionControlCharacteristicResponses. Renvoie la liste des réponses de caractéristique de contrôle de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionControlCharacteristicResponses (INFOTABLE - forme de données PTC.SCA.SCO.WorkDefinitionControlCharacteristicResponse)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionControlCharacteristics : met à jour une ou plusieurs caractéristiques de contrôle de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionControlCharacteristics. Renvoie la liste des caractéristiques de contrôle de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionControlCharacteristics (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionDependencies : met à jour une ou plusieurs dépendances de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionDependencies. Renvoie la liste des illustrations de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionDependencies (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionIllustrations : met à jour une ou plusieurs illustrations de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionIllustrations. Renvoie la liste des illustrations de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionIllustrations (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionLinks : met à jour un ou plusieurs liens de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionLinks. Renvoie la liste des liens de définition de travail qui ont été mis à jour.
• Paramètres d'entrée : WorkDefinitionLinks (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionMaterialSpecificationInstances : met à jour une ou plusieurs instances de spécification de matière de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecificationInstances. Renvoie la liste des instances de spécification de matière de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionMaterialSpecificationInstances (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionMaterialSpecificationLinks : met à jour un ou plusieurs liens de spécification de matière de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecificationLinks. Renvoie la liste des liens de spécification de matière de définition de travail qui ont été mis à jour.
• Paramètres d'entrée : WorkDefinitionMaterialSpecificationLinks (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionMaterialSpecifications : met à jour une ou plusieurs spécifications de matière de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMaterialSpecifications. Renvoie la liste des spécifications de matière de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionMaterialSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionMetadatas : met à jour une ou plusieurs entrées de métadonnées de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionMetadatas. Renvoie la liste des entrées de métadonnées de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionMetadatas (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionPersonnelSpecifications : met à jour une ou plusieurs spécifications de personnel de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionPersonnelSpecifications. Renvoie la liste des spécifications de personnel de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionPersonnelSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionProcessingResourceSpecifications : met à jour une ou plusieurs spécifications de ressource de production de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionProcessingResourceSpecifications. Renvoie la liste des spécifications de ressources de production de définition de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitionProcessingResourceSpecifications (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitionRelatedDocuments : met à jour un ou plusieurs documents connexes de définition de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitionRelatedDocuments. Renvoie la liste des documents associés à la définition de travail qui ont été mis à jour.
• Paramètres d'entrée : WorkDefinitionRelatedDocuments (INFOTABLE)
• Sortie : result (INFOTABLE)
UpdateWorkDefinitions : met à jour une ou plusieurs définitions de travail par UID, sur la base des informations ajoutées à la table de paramètres d'entrée WorkDefinitions. Renvoie la liste des définitions de travail qui ont été mises à jour.
• Paramètres d'entrée : WorkDefinitions (INFOTABLE)
• Sortie : result (INFOTABLE)
Services divers et utilitaires
CloneWorkDefinition : appelle tous les services nécessaires pour cloner une définition de travail spécifiée et toutes ses entités associées. En cas d'échec, ce service supprime toutes les entités de base de données qui ont été créées, ainsi que tous les fichiers binaires qui ont été ajoutés au référentiel de fichiers.
• Paramètres d'entrée : WorkDefinitionUID (STRING). UID de la définition du travail à cloner.
• Sortie : result (INFOTABLE). Table d'informations montrant la définition de travail racine du clone.
CreateWorkDefinitionClone : non destiné à une utilisation autonome. Appelé par CloneWorkDefinition, ce service clone la définition de travail et toutes ses entités associées. Ce service ne procède pas au nettoyage de la base de données en cas d'échec.
• Paramètres d'entrée : WorkDefinitionUID (STRING). UID de la définition du travail à cloner.
• Sortie : result (INFOTABLE). Table d'informations montrant la définition de travail racine du clone.
GetChildren : récupère la liste de toutes les entités enfants de la forme de données spécifiée associée à l'UID de parent spécifié. Utilisé en interne par d'autres services. Non destiné à une utilisation autonome.
• Paramètres d'entrée :
◦ dataShapeName (STRING)
◦ ParentUID (STRING)
• Sortie : result (INFOTABLE)
GetFileType : récupère le type du fichier spécifié en fonction de son extension. Par exemple, un fichier portant l'extension de fichier .gif renvoie le type de fichier 2D ; un fichier portant l'extension de fichier .rtf renvoie le type de fichier TEXT. Utilisé en interne par d'autres services. Non destiné à une utilisation autonome.
• Paramètres d'entrée : FileName (STRING)
• Sortie : result (JSON)
GetWorkDefinitionDBInfo : récupère les informations de table de base de données liées aux définitions de travail, notamment les noms de colonne de table. Utilisé en interne par d'autres services. Non destiné à une utilisation autonome.
• Paramètres d'entrée : aucune entrée
• Sortie : result (JSON)
GetWorkDefinitionRelatedObjects : récupère la liste de tous les objets de la forme de données spécifiée associée à l'UID de définition de travail spécifié. Utilisé en interne par d'autres services. Non destiné à une utilisation autonome.
• Paramètres d'entrée :
◦ dataShapeName (STRING)
◦ WorkDefinitionUID (STRING)
◦ Filter (JSON)
• Sortie : result (INFOTABLE)