Projet

Projet

Projet - Ajouter un nouveau projet

POST  votredomaine.com/api/projects

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

name

String

Nom du projet obligatoire.

rel_type

String

Lié au projet obligatoire.

Valeurs autorisées : "lead", "customer", "internal"

clientid

Number

ID connexe obligatoire.

billing_type

Number

Type de facturation obligatoire.

start_date

Date

Date de début de projet obligatoire.

status

Number

Status de projet obligatoire.

progress_from_tasks (facultatif)

String

Marche ou arrêt facultatif de la progression des tâches.

project_cost (facultatif)

String

Coût du projet facultatif.

progress (facultatif)

String

Avancement du projet facultatif.

project_rate_per_hour (facultatif)

String

Taux de projet optionnel par heure.

estimated_hours (facultatif)

String

Heures estimées du projet facultatif.

project_members (facultatif)

Number[]

Membres de projet facultatifs.

deadline (facultatif)

Date

Échéance facultative du projet.

tags (facultatif)

String

Balises de projet facultatives.

description (facultatif)

String

Facultatif Description du projet.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Projet ajouté avec succès.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de l'ajout du projet.

  • Réponse réussie

HTTP/1.1 200 OK{  "status": true,  "message": "Project add successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Project add fail."}

Projet - Supprimer un projet

SUPPRIMER  votredomaine.com/api/delete/projects/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

ID unique du projet.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Suppression du projet réussie.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la suppression du projet.

  • Réponse réussie

HTTP/1.1 200 OK{  "status": true,  "message": "Project Delete Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Project Delete Fail."}

Projet - Demander des informations sur le projet

OBTENEZ  votredomaine.com/api/projects/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

ID unique du projet.

Succès 200

json

Champ

Type

Description

Projet

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.

  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "28",
"name": "Test1",
"description": null,
"status": "1",
"clientid": "11",
"billing_type": "3",
"start_date": "2019-04-19",
"deadline": "2019-08-30",
"project_created": "2019-07-16",
"date_finished": null,
"progress": "0",
"progress_from_tasks": "1",
"project_cost": "0.00",
"project_rate_per_hour": "0.00",
"estimated_hours": "0.00",
"addedfrom": "5",
"rel_type": "lead",
"potential_revenue": "0.00",
"potential_margin": "0.00",
"external": "E",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "No data were found"}

Projet - Rechercher des informations sur le projet

OBTENEZ  votredomaine.com/api/projects/search/:keysearch

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

Keysearch

String

Rechercher des mots-clés.

Succès 200

json

Champ

Type

Description

Project

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.

  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "28",
"name": "Test1",
"description": null,
"status": "1",
"clientid": "11",
"billing_type": "3",
"start_date": "2019-04-19",
"deadline": "2019-08-30",
"project_created": "2019-07-16",
"date_finished": null,
"progress": "0",
"progress_from_tasks": "1",
"project_cost": "0.00",
"project_rate_per_hour": "0.00",
"estimated_hours": "0.00",
"addedfrom": "5",
"rel_type": "lead",
"potential_revenue": "0.00",
"potential_margin": "0.00",
"external": "E",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "No data were found"}

Projet - Mettre à jour un projet

PUT  votredomaine.com/api/projects/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

name

String

Nom du projet obligatoire.

rel_type

String

Lié au projet obligatoire.

Valeurs autorisées : "lead", "customer", "internal"

clientid

Number

ID connexe obligatoire.

billing_type

Number

Type de facturation obligatoire.

start_date

Date

Date de début de projet obligatoire.

status

Number

Status de projet obligatoire.

progress_from_tasks (facultatif)

String

Marche ou arrêt facultatif de la progression des tâches.

project_cost (facultatif)

String

Coût du projet facultatif.

progress (facultatif)

String

Avancement du projet facultatif.

project_rate_per_hour (facultatif)

String

Taux de projet optionnel par heure.

estimated_hours (facultatif)

String

Heures estimées du projet facultatif.

project_members (facultatif)

Number[]

Membres de projet facultatifs.

deadline (facultatif)

Date

Échéance facultative du projet.

tags (facultatif)

String

Balises de projet facultatives.

description (facultatif)

String

Facultatif Description du projet.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Mise à jour du projet réussie.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la mise à jour du projet.

  • Réponse réussie

HTTP/1.1 200 OK{  "status": true,  "message": "Project Update Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Project Update Fail."}

Avez-vous trouvé cet article utile ?

  • Introduction

    API REST GlueCRM Commandes disponibles et exemples d'API REST pour GlueCRM Introduction L'API foncti...
  • Clients

    Client Client - Ajouter un nouveau client POST votredomaine.com/api/customers Header json Champ...
  • Contacts

    Contact Contact - Ajouter un nouveau contact POST votredomaine.com/api/contacts/ Header json Ch...
  • Factures

    Facture Facture - Ajouter une nouvelle facture POST votredomaine.com/api/invoices Header json C...
  • Articles

    Articles Articles - Demander des informations sur les articles OBTENEZ votredomaine.com/api/items/i...