invantive documentation
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

PlanningItems : Robaws Planning Items

insert update delete REST

  • Catalogue : Robaws
  • Schéma : PlanningItems
  • Clés primaires : id
  • Libellé : Planning Items

Rechercher

Permet de récupérer et de modifier des données à l'aide de insert, update et delete.

Source de l'API

  • Point de terminaison : /api/v2/planning-items
  • Opération : get /api/v2/planning-items

Caractéristiques de performance

Characteristic Value
Latence moyenne d'accès (ms) 145
Nombre de lignes par minute en mode de balayage complet 21,036
Nombre de lignes de requêtes ponctuelles par minute 513
Nombre d'enregistrements écrits par minute 539

Le résultat peut être mis en cache côté client.

Paramètres

Name Type de données Required Default Documentation
employeeId ``
fromDate ``
inWaitingRoom ``
materialId ``
orderId ``
projectId ``
salesOrderId ``
searchText ``
sort ``
toDate ``
updatedFrom ``
withArchived ``

Colonnes de table

Les colonnes de la table PlanningItems sont présentées ci-dessous. Chaque colonne possède un type de données SQL. Une nouvelle valeur non nulle doit être fournie pour chaque colonne requise à tout moment lors de l'insertion et de la mise à jour.

Name Type de données Label Required Marks Documentation
address_addressLine1 varchar2 Adresse ligne 1 filtres sur la plateforme, modifiables, address.addressLine1
address_addressLine2 varchar2 Adresse ligne 2 filtres sur la plateforme, modifiables, address.addressLine2
address_city varchar2 City filtres sur la plateforme, modifiables, address.city
address_country varchar2 Country filtres sur la plateforme, modifiables, address.country
address_latitude double Latitude de l'adresse filtres sur la plateforme, modifiables, address.latitude
address_longitude double Longitude de l'adresse filtres sur la plateforme, modifiables, address.longitude
address_postalCode varchar2 Adresse Code postal filtres sur la plateforme, modifiables, address.postalCode
archivedAt datetime Archivé à filtres sur la plateforme, modifiables, archivedAt
basePlanningItemId varchar2 ID de l'élément de planification de base filtres sur la plateforme, modifiables, basePlanningItemId
clientId varchar2 Id du client filtres sur la plateforme, modifiables, clientId
clientReference varchar2 Référence client filtres sur la plateforme, modifiables, clientReference
companyId varchar2 ID de l'entreprise filtres sur la plateforme, modifiables, companyId
contactId varchar2 ID de contact filtres sur la plateforme, modifiables, contactId
createdAt datetime Créé le filtres sur la plateforme, modifiables, createdAt
deletedAt datetime Supprimé le filtres sur la plateforme, modifiables, deletedAt
description varchar2 Description filtres sur la plateforme, modifiables, description Contenu HTML.Les images intégrées sont résolues en URL selon l'en-tête de requête 'x-robaws-html-image-mode' : TEMPORARY_URL (par défaut) renvoie des URL pré-signées à durée limitée qui ne nécessitent aucune authentification ; PERMANENT_URL renvoie des URL stables qui nécessitent une session authentifiée ; NONE renvoie le HTML stocké, où chaque image est une avec un data-robaws-id et un src vide — conservez cette balise et son data-robaws-id lors de la réécriture du HTML, faute de quoi l'image sera perdue.Toute autre valeur (par ex.BASE64_INLINE) renvoie 400 Bad Request.
endClientContactId varchar2 Identifiant de contact du client final filtres sur la plateforme, modifiables, endClientContactId
endClientId varchar2 Client ID filtres sur la plateforme, modifiables, endClientId
endDate datetime Date de fin filtres sur la plateforme, modifiables, endDate Un élément se trouve dans la salle d'attente, et non dans la planification du jour, tant que sa date de début ou sa date de fin est vide.Pour obtenir la salle d'attente, filtrez sur une date vide (un OU des deux).Un élément figure dans la planification du jour d'une période lorsqu'il chevauche celle-ci : startDate est antérieur ou égal au dernier jour de la période et endDate postérieur ou égal à son premier jour ; filtrer uniquement sur startDate omet les éléments commencés avant la période.
executionPhaseDetail varchar2 Détails de la phase d'exécution filtres sur la plateforme, modifiables, executionPhaseDetail
executionPhaseId varchar2 Identifiant de la phase d'exécution filtres sur la plateforme, modifiables, executionPhaseId
externalId varchar2 Id Externe filtres sur la plateforme, modifiables, externalId
extraFields varchar2 Champs supplémentaires writable Le texte JSON de l'objet imbriqué.
hourTypeId varchar2 Identifiant du type d'heure filtres sur la plateforme, modifiables, hourTypeId
id varchar2 ID filtres sur la plateforme, modifiables, id
lockedAt datetime Verrouillé à filtres sur la plateforme, modifiables, lockedAt
numberOfWorkOrders int32 Nombre d'ordres de travail filtres sur la plateforme, modifiables, numberOfWorkOrders Lors de la lecture, présent uniquement si demandé via le paramètre de requête 'include', sinon null.
phaseId varchar2 Phase d'identification filtres sur la plateforme, modifiables, phaseId
planningTypeId varchar2 Identifiant du type de planification filtres sur la plateforme, modifiables, planningTypeId
projectId varchar2 Identifiant du projet filtres sur la plateforme, modifiables, projectId
recurrenceEndDate datetime Date de fin de la récurrence filtres sur la plateforme, modifiables, recurrenceEndDate
recurrenceRule varchar2 Règle de récurrence filtres sur la plateforme, modifiables, recurrenceRule
recurring char Recurring filtres sur la plateforme, modifiables, recurring
recurringMode varchar2 Mode récurrent filtres sur la plateforme, modifiables, recurringMode Obsolète, utilisez recurrenceRule à la place.
salesOrderId varchar2 Référence de la commande client filtres sur la plateforme, modifiables, salesOrderId
startDate datetime Date de début filtres sur la plateforme, modifiables, startDate Un élément se trouve dans la salle d'attente, et non dans la planification du jour, tant que sa date de début ou sa date de fin est vide.Pour obtenir la salle d'attente, filtrez sur une date vide (un OU des deux).Un élément figure dans la planification du jour d'une période lorsqu'il chevauche celle-ci : startDate est antérieur ou égal au dernier jour de la période et endDate postérieur ou égal à son premier jour ; filtrer uniquement sur startDate omet les éléments commencés avant la période.
summary varchar2 Summary filtres sur la plateforme, modifiables, summary
timeAndMaterial char Temps et matière filtres sur la plateforme, modifiables, timeAndMaterial
timeOffCategoryId varchar2 Identifiant de la catégorie de congé filtres sur la plateforme, modifiables, timeOffCategoryId
transportId varchar2 Référence de transport filtres sur la plateforme, modifiables, transportId
unavailableReason varchar2 Raison de l'indisponibilité filtres sur la plateforme, modifiables, unavailableReason Obsolète, utilisez timeOffCategory à la place.
unavailableReasonDetails_color varchar2 Motif d'indisponibilité Détails Couleur filtres sur la plateforme, modifiables, unavailableReasonDetails.color
unavailableReasonDetails_name varchar2 Motif d'indisponibilité Détails Nom filtres sur la plateforme, modifiables, unavailableReasonDetails.name
updatedAt datetime Mise à jour à filtres sur la plateforme, modifiables, updatedAt

Clés

Key Column Se réfère à Kind Description
PlanningItems_basePlanningItemId_fk basePlanningItemId PlanningItems.id Key
PlanningItems_clientId_fk clientId Clients.id Key
PlanningItems_companyId_fk companyId Companies.id Key
PlanningItems_contactId_fk contactId Contacts.id Key
PlanningItems_endClientContactId_fk endClientContactId Contacts.id Key
PlanningItems_endClientId_fk endClientId Clients.id Key
PlanningItems_executionPhaseId_fk executionPhaseId ExecutionPhases.id Key
PlanningItems_planningTypeId_fk planningTypeId PlanningTypes.id Key
PlanningItems_salesOrderId_fk salesOrderId SalesOrders.id Key

Référencée

Notes de Version

Quels ont été les changements apportés à chaque version au niveau des tables, des colonnes, des attributs et des fonctionnalités du chauffeur :