Documentation API
Créer un billet
Cet API permet de créer un nouveau billet dans l’application.
URL
{Url_Application}/API/Ticket/Save
Type de requête
POST
Paramètres URL
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
Syntaxe :
{Url_Application}/API/Ticket/Save?username=Username&password=Password
Codes de réponse avec succès
- Code de l’entête HTML : 200.
- Code de la réponse JSON : "Status":0,"
Exemple d’appel (sans champs personnalisés)
{
"viewModel": {
"EnterpriseId": "04a1e54f-fbf9-4cd1-93b3-5a7ae9489c46",
"TicketTypeId": "19f57377-94fd-4391-a154-577446131999",
"IsTicket": true,
"Clients": [
{
"Id": "b2156d17-7156-43fa-b021-200d7a9f2f01"
}
],
"Assignees": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"Resources": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"CIs": [],
"StateId": null,
"QueueId": "7ec07c17-828f-47f8-9519-76f7e9a32cb0",
"OriginId": "0860ed6b-512d-4957-b0cb-e7e5cc759bc8",
"CatalogId": "00000000-0000-0000-0000-000000000000",
"CategoryId": "1bb3365b-95ff-4ec1-ab2e-49f0d3dc4467",
"ServiceId": "22d742b3-b85e-4542-862b-921fd3df4dba",
"RequestId": "3e2eee86-2dd5-4465-b8f9-7df2ecd6c297",
"PriorityId": null,
"Groups": [],
"ClientAssignees": [],
"Summary": "Exemple de demande 1",
"StatusId": "1d0b2a8d-0c81-4553-9ac8-7adb1fcca5d0"
},
"username": "admin",
"password": "pax123"
}
Exemple de réponse (sans champs personnalisés)
{
"viewModel": {
"EnterpriseId": "04a1e54f-fbf9-4cd1-93b3-5a7ae9489c46",
"TicketTypeId": "19f57377-94fd-4391-a154-577446131999",
"IsTicket": true,
"Clients": [
{
"Id": "b2156d17-7156-43fa-b021-200d7a9f2f01"
}
],
"Assignees": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"Resources": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"CIs": [],
"StateId": null,
"QueueId": "7ec07c17-828f-47f8-9519-76f7e9a32cb0",
"OriginId": "0860ed6b-512d-4957-b0cb-e7e5cc759bc8",
"CatalogId": "00000000-0000-0000-0000-000000000000",
"CategoryId": "1bb3365b-95ff-4ec1-ab2e-49f0d3dc4467",
"ServiceId": "22d742b3-b85e-4542-862b-921fd3df4dba",
"RequestId": "3e2eee86-2dd5-4465-b8f9-7df2ecd6c297",
"PriorityId": null,
"Groups": [],
"ClientAssignees": [],
"Summary": "Exemple de demande 1",
"StatusId": "1d0b2a8d-0c81-4553-9ac8-7adb1fcca5d0"
},
"username": "admin",
"password": "pax123"
}
Exemple d’appel (avec champs personnalisés, section « CustomFields »)
{
"viewModel": {
"EnterpriseId": "04a1e54f-fbf9-4cd1-93b3-5a7ae9489c46",
"TicketTypeId": "19f57377-94fd-4391-a154-577446131999",
"StatusId": "1d0b2a8d-0c81-4553-9ac8-7adb1fcca5d0",
"IsTicket": true,
"Clients": [
{
"Id": "b9498fa8-9629-49c4-b09d-9dc2d2216675"
}
],
"Assignees": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"Resources": [
{
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf"
}
],
"CIs": [],
"StateId": null,
"QueueId": "7ec07c17-828f-47f8-9519-76f7e9a32cb0",
"OriginId": "0860ed6b-512d-4957-b0cb-e7e5cc759bc8",
"CatalogId": "00000000-0000-0000-0000-000000000000",
"CategoryId": "1bb3365b-95ff-4ec1-ab2e-49f0d3dc4467",
"ServiceId": "22d742b3-b85e-4542-862b-921fd3df4dba",
"RequestId": "3e2eee86-2dd5-4465-b8f9-7df2ecd6c297",
"Summary": "Exemple de demande 1",
"CustomFields": {
"Fields": [
{
"Id": "9f9923ff-a0a4-495b-baf7-c66f3fdfaa51",
"Value": "True"
},
{
"Id": "8c05d7fa-c9b6-42ba-a610-7fef42348ea5",
"Value": "123.45"
},
{
"Id": "b9665f7a-065d-4aae-a4f7-82c60759aa64",
"Value": "40dcb93b-e4ab-4bfc-bfe8-4897120ee1ef"
},
{
"Id": "195bd1f6-b5db-4101-80bb-9f17b20c164e",
"Value": "2018-07-05T04:00:00.000Z"
}
],
"Sections": [
{
"Rows": [
{
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"field": {
"Id": "9f9923ff-a0a4-495b-baf7-c66f3fdfaa51",
"Value": "True"
}
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"field": {
"Id": "8c05d7fa-c9b6-42ba-a610-7fef42348ea5",
"Value": "123.45"
}
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"field": {
"Id": "b9665f7a-065d-4aae-a4f7-82c60759aa64",
"Value": "40dcb93b-e4ab-4bfc-bfe8-4897120ee1ef"
}
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"field": {
"Id": "195bd1f6-b5db-4101-80bb-9f17b20c164e",
"Value": "2018-07-05T04:00:00.000Z"
}
}
]
}
],
"Id": "9309519b-9d24-5b7c-8e60-bb642b9a0068"
}
]
}
},
"username": "admin",
"password": "pax123"
}
Exemple de réponse (avec champs personnalisés, section « CustomFields »)
{
"Status": 0,
"Data": {
"Id": "d32e3e93-d23e-434f-ab19-b8164b5ff901",
"CategoryId": "1bb3365b-95ff-4ec1-ab2e-49f0d3dc4467",
"ServiceId": "22d742b3-b85e-4542-862b-921fd3df4dba",
"RequestId": "3e2eee86-2dd5-4465-b8f9-7df2ecd6c297",
"IsDescriptionSectionVisible": true,
"IsDraftAllowed": false,
"CatalogId": "00000000-0000-0000-0000-000000000000",
"EnterpriseId": "04a1e54f-fbf9-4cd1-93b3-5a7ae9489c46",
"EnterpriseName": "Selenium Tests",
"CategoryName": "Exemple de Categorie",
"ServiceName": "Exemple de Service 1",
"RequestName": "Exemple de demande 1",
"EnterpriseUnavailabilityReasonId": null,
"Description": null,
"OriginId": "0860ed6b-512d-4957-b0cb-e7e5cc759bc8",
"Summary": "Exemple de demande 1",
"TicketTypeId": "19f57377-94fd-4391-a154-577446131999",
"StatusId": "1d0b2a8d-0c81-4553-9ac8-7adb1fcca5d0",
"StateId": null,
"ChangeTypeId": null,
"QueueId": "7ec07c17-828f-47f8-9519-76f7e9a32cb0",
"Assignees": [
{
"AssigneeType": 0,
"EmailSent": false,
"RelationId": "33c3c967-d2f2-4d9c-a1a5-988bcb490e68",
"Id": "d27a6354-b382-4e3f-ae35-e417f3b580cf",
"SequenceNumber": "00000000",
"UserName": "selenium-tests@c2enterprise.com",
"FirstName": "Selenium",
"LastName": "Tests",
"IsActive": true,
"FullName": "Selenium Tests",
"Text": null,
"Icon": "Content/Images/user.png",
"NameId": "00000000-0000-0000-0000-000000000000",
"IsPrincipal": true,
"ResourceState": {
"IsAssignableToTicket": true,
"ResourceStateColor": "#89A600",
"Description": "",
"Id": "63690208-2caf-4283-8af8-4a097a407433",
"Text": "Disponible",
"ImagePath": "Content/catalogimages/catalog_other.png",
"Code": "ResourceStateAvailable",
"SequenceNumber": 1,
"Items": null,
"IsActive": true
}
}
],
"Clients": [
{
"EmailAddress": "clientapiI@test.ca",
"RelationId": "692d9478-f234-4e80-b078-374498daa181",
"Id": "b9498fa8-9629-49c4-b09d-9dc2d2216675",
"SequenceNumber": "00000599",
"FirstName": "Client",
"LastName": "API",
"FullName": "Client API",
"UserName": null,
"Address": "",
"OfficePhone": null,
"IsActive": true,
"IsPrimary": false,
"IsPrincipal": true,
"RoleId": null,
"CatalogId": null,
"EnterpriseId": "04a1e54f-fbf9-4cd1-93b3-5a7ae9489c46",
"EnterpriseName": "Selenium Tests",
"ApprovalEmailSent": false,
"SearchField1": null,
"SearchField2": null,
"HasRemoteApplication": false,
"TemplateId": "838dad1a-72a0-4747-a2a7-3364b801cebd",
"AssigneeType": 1,
"value": "Client API"
}
],
"ReferencesBy": [],
"CustomFields": {
"Fields": [
{
"Id": "04e7fb57-6281-4db9-8fde-1f4634bd7157",
"Order": 0,
"Value": "False",
"Description": null,
"Name": "CF Checkbox",
"FieldSectionId": "9309519b-9d24-5b7c-8e60-bb642b9a0068",
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"DefinitionType": 8,
"DefinitionSequenceNumber": 3,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "False",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "0a00d2ca-7d32-4641-afaa-40a1d695589c",
"Order": 1,
"Value": null,
"Description": null,
"Name": "CF Decimal",
"FieldSectionId": "9309519b-9d24-5b7c-8e60-bb642b9a0068",
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"DefinitionType": 1,
"DefinitionSequenceNumber": 7,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": "{\"DecimalPlaces\":2}",
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "75817c12-053f-4557-a8ab-80353a316f04",
"Order": 2,
"Value": null,
"Description": null,
"Name": "CF Client",
"FieldSectionId": "9309519b-9d24-5b7c-8e60-bb642b9a0068",
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"DefinitionType": 6,
"DefinitionSequenceNumber": 5,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": true,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "39d94978-9b85-4078-a15c-eb96c9a90f13",
"Order": 3,
"Value": null,
"Description": null,
"Name": "CF Datetime",
"FieldSectionId": "9309519b-9d24-5b7c-8e60-bb642b9a0068",
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"DefinitionType": 3,
"DefinitionSequenceNumber": 6,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
}
],
"Sections": [
{
"IsPublic": true,
"OverrideOptions": false,
"Order": 1,
"VisibleIfFieldDefinitionId": null,
"VisibleIfFieldValue": null,
"FieldSectionTemplateId": null,
"FromTemplate": false,
"Rows": [
{
"Order": 0,
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b"
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727"
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9"
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577"
}
]
}
],
"EnglishName": "Additional Information",
"FrenchName": "Informations additionnelles",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "2069a4d9-51c6-ee7a-d86b-4dd12bedcec6",
"DescriptionId": "0afa691e-84ef-5207-6464-877ab9a2ef7c",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000029",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530800605850)/",
"LastModifiedBy": "selenium-tests@c2enterprise.com",
"LastModifiedDateTime": "/Date(1530800605850)/",
"Id": "9309519b-9d24-5b7c-8e60-bb642b9a0068"
}
]
},
"CIs": [],
"Workflows": [
{
"Id": "ba964e85-0300-45c3-b55a-50f8c35c1480",
"SequenceNumber": 0,
"RelatedTicketId": null,
"TaskTemplateId": "765b7076-ef57-409e-8cd9-e1c23b11b2ab",
"RequestTemplateId": null,
"Step": 1,
"StatusId": "00000000-0000-0000-0000-000000000000",
"StatusCode": null,
"InsertedDate": "/Date(1530802445827)/",
"Type": 0,
"LastModifiedDateTime": "/Date(1530802445643)/",
"TicketTypeId": "e2609e13-0d39-4223-88a5-7090637706ee",
"RelatedSequenceNumber": 1,
"Summary": "Exemple de tache",
"Description": "<p></p>",
"Status": null,
"Queue": null,
"DueDate": null,
"AssignedResources": null,
"PrincipalResource": null,
"PrincipalApprover": null,
"IsReady": true,
"IsBlocking": true,
"IsDone": false,
"IsApproval": false,
"IsTask": false,
"IsDraft": false,
"ParentId": null,
"SubWorkflows": [],
"ParentConditionResult": null,
"ConditionResult": null,
"ConditionGroups": [],
"Actions": [],
"NameId": null,
"Name": "",
"EnglishName": "",
"FrenchName": ""
}
],
"Attachments": {
"NoAttachments": true,
"TicketNumber": "00012672",
"TicketId": "d32e3e93-d23e-434f-ab19-b8164b5ff901",
"Records": []
},
"IsReadonly": false,
"IsPublic": false,
"IsLocked": false,
"LockedBy": null,
"LockedSince": null,
"IsClosedTicket": false,
"IsTicket": true,
"ResponseDate": "/Date(1530802445300)/",
"DueDate": "/Date(1530802445300)/",
"SelectedDueDate": null,
"ReactivationDate": null,
"FirstAssignationDate": "/Date(1530802445300)/",
"TakingChargeDate": null,
"ResolutionDate": null,
"ClosedDateTime": null,
"ImplementationDate": null,
"PriorisationDate": null,
"PrioritySequenceNumber": null,
"PriorityName": "",
"CreatedOn": "/Date(1530802445300)/",
"CreatedBy": "admin",
"LastModifiedOn": "/Date(1530802445300)/",
"LastModifiedBy": "admin",
"ClosedBy": null,
"Duration": "0.00:00:00",
"EstimatedDuration": "0.00:00:00",
"TotalDuration": "0.00:00:00",
"DifferenceDuration": "0.00:00:00",
"ClientRoleId": null,
"ClosingReasonId": null,
"BusinessServiceId": null,
"ParentTicketId": null,
"ParentTicketNumber": null,
"ParentTicketTypeId": null,
"ParentTicketRequestId": null,
"PriorityId": null,
"UrgencyId": null,
"ImpactId": null,
"LevelId": null,
"KBItemId": null,
"KBItemName": "",
"TechnicalResolution": null,
"ClientResolution": null,
"ResolutionTypeId": null,
"WorkflowId": null,
"WorkflowParentId": null,
"WorkflowParentConditionResult": null,
"ExternalId": null,
"SequenceNumber": 12672,
"Cost": 0,
"Price": 0,
"ResponseTime": 0,
"ResponseTimeUnit": 0,
"ResolutionTime": 0,
"ResolutionTimeUnit": 0,
"WorkingHours247": false,
"Step": null,
"IsReady": true,
"TaskTemplateId": null,
"ApprovalDate": null,
"ReasonForRejection": null,
"IsSurveyCompleted": false,
"IsCalendarFullDay": false,
"CalendarStartDate": null,
"CalendarEndDate": null,
"CopiedFromSequenceNumber": null,
"IsDraft": false,
"WasDraft": false,
"ResponseWaitingTime": 0,
"DueDateWaitingTime": 0,
"IncludeClientAssignation": false,
"UnreadCommunicationsCount": 0,
"CommunicationsCount": 0
},
"Message": null,
"Time": "/Date(1530802445954)/"
}
NOTES
- La ressource qui exécute l’appel API doit posséder la permission de créer des billets dans l’application.
Mettre à jour un billet
Cet API permet de mettre à jour un billet dans l’application.
URL
{Url_Application}/API/Ticket/UpdateProperty
Type de requête
POST
Paramètres URL
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
Syntaxe : {Url_Application}/API/Ticket/UpdateProperty?username=Username&password=Password
Codes de réponse avec succès
- Code de l’entête HTML: 200.
- Code de la réponse JSON: "Status":0,"
Exemple d’appel (champ système)
Les paramètres passés dans l’appel
- « Id » : le Id du billet.
- « PropertyName » : le nom du champ système à mettre à jour.
« Value » : la nouvelle valeur du champ système.
{
"Id" : "d2ec3037-7477-47cd-87ff-3a3c80a9191c",
"PropertyName" : "Summary",
"Value" : "New Summary",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ système)
{
"Status": 0,
"Data": true,
"Message": null,
"Time": "/Date(1530715358928)/"
}
Exemple d’appel (champ personnalisé)
Les paramètres passés dans l’appel:
- « Id » : le Id du billet.
- « CustomFieldSequenceNumber » : le numéro de séquence du champ personnalisé à mettre à jour.
- « Value » : la nouvelle valeur du champ personnalisé.
{
"Id" : "814d217f-fcbd-4098-9e77-f3b518b289bd",
"CustomFieldSequenceNumber" : "3",
"Value" : "false",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ personnalisé)
{
"Status": 0,
"Data": true,
"Message": null,
"Time": "/Date(1530715923016)/"
}
NOTES
- La ressource qui exécute l’appel API doit posséder la permission de modifier des billets dans l’application.
Créer un client
API - Comment créer un Client
Cet API permet de créer un nouveau client dans l’application.
URL
{Url_Application}/API/Clients/Save
Type de requête
POST
Codes de réponse avec succès
- Code de l’entête HTML: 200.
- Code de la réponse JSON: "Status":0,"
Exemple d’appel (sans champs personnalisés)
{
"viewModel": {
"Enterprises": [
{
"Id": "<EnterpriseId>"
}
],
"FirstName": "<Client First Name>",
"LastName": "<Client Last Name>"
},
"UserName": "<your user name>",
"Password":"<your password>"
}
Paramètres haut niveau pour la requête
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
- viewModel : contient les éléments de la requête.
Tableau des attributs pour une requête Client (Sous "viewModel")
| Requis | Attribut | Description | Valeur par défaut | Valeur possible |
| x | Entreprise | liste des entreprises associées au client | ||
| x | FirstName | Le prénom du client | ||
| x | LastName | Le nom de famille du client | ||
| IsActive | Le client est actif | true | true / false | |
| HasPortalAccess | Le client peut utiliser le portail (UserName est requis) | false | true / false | |
| PreferedCulture | La langue que le client utilise au portail | fr-CA / en-US | ||
| StreetName | Adresse du client | Null | ||
| City | La ville du client | Null | ||
| PostalCode | Le code postal du client | Null | ||
| OfficePhone | Numéro de téléphone au bureau | Null | ||
| CountryId | Numéro d’identification du pays | Null | ||
| Gender | Le genre du client | M / F | ||
| EmailAddress | L’adresse courriel du client | |||
| UserName | Le nom d’usager pour accéder au portail |
L'atttribut Enterprises
- Dans l'attribut "Enterprise" seul l'identifiant de l'entreprise est requis pour faire la requête.
{
"Enterprises": [
{
"Id": "<EnterpriseId>"
}
]
}
Il est aussi possible d'associer plusieurs entreprises à un client.
{
"Enterprises": [
{
"Id": "<EnterpriseId 1>"
},
{
"Id": "<EnterpriseId 2>"
},
{
"Id": "<EnterpriseId n>"
}
]
}
Ajouter l'attribue "CustomFields" à l'intérieur du "viewModel"
Exemple d’appel (avec champs personnalisés, section « CustomFields »)
{
"viewModel": {
"Enterprises": [
{
"Id": "<EnterpriseId>"
}
],
"CustomFields": {},
"FirstName": "<Client First Name>",
"LastName": "<Client Last Name>"
},
"UserName": "<your user name>",
"Password":"<your password>"
}
- Pour avoir plus d'informations pour l'ajout d'une section de champs personnalisés voir l'article API - Comment ajouter une section de champs personnalisés dans une requête.
NOTE
- La ressource qui exécute l’appel API doit posséder la permission de créer des clients dans l’application.
Mettre à jour un client
Cet API permet de mettre à jour un billet dans l’application.
URL
{Url_Application}/API/Clients/UpdateProperty
Type de requête
POST
Paramètres URL
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
Syntaxe : {Url_Application}/API/Clients/UpdateProperty?username=Username&password=Password
Codes de réponse avec succès
- Code de l’entête HTML: 200.
- Code de la réponse JSON: "Status":0,"
Exemple d’appel (champ système)
Les paramètres passés dans l’appel
- « Id » : le Id du client.
- « PropertyName » : le nom du champ système à mettre à jour.
« Value » : la nouvelle valeur du champ système.
{
"Id" : "b9498fa8-9629-49c4-b09d-9dc2d2216675",
"PropertyName" : "HasPortalAccess",
"Value" : "false",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ système)
{
"Status": 0,
"Data": {
"Id": "b9498fa8-9629-49c4-b09d-9dc2d2216675",
"SequenceNumber": "00000599",
"Message": "Client API",
"ParentId": null,
"HasPortalAccess": false,
"UserName": "clientapi",
"CustomFields": {
"Fields": [],
"Sections": []
},
"NameId": null,
"DescriptionId": null,
"Data": null,
"ExternalId": null
},
"Message": null,
"Time": "/Date(1530717564201)/"
}
Exemple d’appel (champ personnalisé)
{
"Id" : "40dcb93b-e4ab-4bfc-bfe8-4897120ee1ef",
"CustomFieldSequenceNumber" : "3",
"Value" : "false",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ personnalisé)
{
"Status": 0,
"Data": {
"Id": "40dcb93b-e4ab-4bfc-bfe8-4897120ee1ef",
"SequenceNumber": "00000600",
"Message": "Client2 API",
"ParentId": null,
"HasPortalAccess": true,
"UserName": "client2api",
"CustomFields": {
"Fields": [
{
"Id": "f20dc467-4934-4f0b-978a-28603c2f37cf",
"Order": 0,
"Value": "False",
"Description": null,
"Name": "CF Checkbox",
"FieldSectionId": "9e5f1aae-9229-e4a0-7e2f-dded0b9219cc",
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"DefinitionType": 8,
"DefinitionSequenceNumber": 3,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "False",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "d971338c-b71c-4225-bde3-2d9aa4ccbc98",
"Order": 1,
"Value": null,
"Description": null,
"Name": "CF Decimal",
"FieldSectionId": "9e5f1aae-9229-e4a0-7e2f-dded0b9219cc",
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"DefinitionType": 1,
"DefinitionSequenceNumber": 7,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": "{\"DecimalPlaces\":2}",
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "7ee6eec2-6e2e-4848-9933-fbc90bf85c6e",
"Order": 2,
"Value": null,
"Description": null,
"Name": "CF Client",
"FieldSectionId": "9e5f1aae-9229-e4a0-7e2f-dded0b9219cc",
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"DefinitionType": 6,
"DefinitionSequenceNumber": 5,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": true,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "6422c79c-8fcf-4e0e-b578-64c2681b3e29",
"Order": 3,
"Value": null,
"Description": null,
"Name": "CF Datetime",
"FieldSectionId": "9e5f1aae-9229-e4a0-7e2f-dded0b9219cc",
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"DefinitionType": 3,
"DefinitionSequenceNumber": 6,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
}
],
"Sections": [
{
"IsPublic": true,
"OverrideOptions": false,
"Order": 1,
"VisibleIfFieldDefinitionId": null,
"VisibleIfFieldValue": null,
"FieldSectionTemplateId": null,
"FromTemplate": false,
"Rows": [
{
"Order": 0,
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b"
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727"
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9"
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577"
}
]
}
],
"EnglishName": "Additional Information",
"FrenchName": "Informations additionnelles",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "c2b39dab-f2b4-a91f-fc39-c3eed26efecd",
"DescriptionId": "8059c227-ca28-f127-21cc-b5419eda2161",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000027",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530718525673)/",
"LastModifiedBy": "selenium-tests@c2enterprise.com",
"LastModifiedDateTime": "/Date(1530718525673)/",
"Id": "9e5f1aae-9229-e4a0-7e2f-dded0b9219cc"
}
]
},
"NameId": null,
"DescriptionId": null,
"Data": null,
"ExternalId": null
},
"Message": null,
"Time": "/Date(1530718625654)/"
}
NOTES
- La ressource qui exécute l’appel API doit posséder la permission de modifier des clients dans l’application.
Créer un item de configuration (CI)
Cet API permet de créer un nouveau client dans l’application.
URL
{Url_Application}/API/CI/Save
Type de requête
POST
Paramètres URL
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
Syntaxe :
{Url_Application}/API/CI/Save?username=Username&password=Password
Codes de réponse avec succès
- Code de l’entête HTML : 200.
- Code de la réponse JSON : "Status":0,"
Exemple d’appel (sans champs personnalisés)
{
"viewModel": {
"CIFolderId": "867a0cc0-a85a-4b80-bd69-d0cbb11d051b",
"CategoryId": "eab2c263-6a90-41bd-bdb7-c45a091f9326",
"StateId":"3b302329-5610-4ee4-97e9-e8590be84b63",
"CITicketsCount": 0,
"EnglishName": "CIAPI",
"FrenchName": "CIAPI"
},
"username": "admin",
"password": "pax123"
}
Exemple de réponse (sans champs personnalisés)
{
"Status": 0,
"Data": {
"StateId": "3b302329-5610-4ee4-97e9-e8590be84b63",
"OwnerId": null,
"OwnerName": null,
"Attachments": [],
"CINumber": "00000010",
"Id": "e33ce7a9-cc55-456a-91ec-778c82a4184a",
"SequenceNumber": "00000221",
"Message": null,
"ParentId": null,
"HasPortalAccess": false,
"UserName": null,
"CustomFields": {
"Fields": [],
"Sections": []
},
"NameId": "09761031-a57e-49c5-859a-665416e031a2",
"DescriptionId": "a72a8a85-8baa-4ca0-ad5d-0ed0175832a6",
"Data": null,
"ExternalId": null
},
"Message": null,
"Time": "/Date(1530719073333)/"
}
Exemple d’appel (avec champs personnalisés, section « CustomFields »)
{
"viewModel": {
"CIFolderId": "867a0cc0-a85a-4b80-bd69-d0cbb11d051b",
"CategoryId": "eab2c263-6a90-41bd-bdb7-c45a091f9326",
"CustomFields": {
"Fields": [
{
"Id": "dc2446c3-aa02-41a6-a2fe-bec07602e9a0",
"Value": "True"
},
{
"Id": "4976ce51-3c90-4c17-9d4c-1bb658019df0",
"Value": "123.45"
},
{
"Id": "25bbe4cd-3848-420b-b59d-532d8751129d",
"Value": "40dcb93b-e4ab-4bfc-bfe8-4897120ee1ef"
},
{
"Id": "50c530dc-2c5b-4707-a857-2db35d7f05f6",
"Value": "2018-07-05T04:00:00.000Z"
}
],
"Sections": [
{
"Rows": [
{
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"field": {
"Id": "dc2446c3-aa02-41a6-a2fe-bec07602e9a0"
}
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"field": {
"Id": "4976ce51-3c90-4c17-9d4c-1bb658019df0"
}
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"field": {
"Id": "25bbe4cd-3848-420b-b59d-532d8751129d"
}
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"field": {
"Id": "50c530dc-2c5b-4707-a857-2db35d7f05f6"
}
}
]
}
],
"Id": "ced377b7-ea01-fcd2-2703-59de30ac9d7f"
}
]
},
"StateId": "3b302329-5610-4ee4-97e9-e8590be84b63",
"EnglishName": "CIAPI2",
"FrenchName": "CIAPI2"
},
"username": "admin",
"password": "pax123"
}
Exemple de réponse (avec champs personnalisés, section « CustomFields »)
{
"Status": 0,
"Data": {
"StateId": "3b302329-5610-4ee4-97e9-e8590be84b63",
"OwnerId": null,
"OwnerName": null,
"Attachments": [],
"CINumber": "00000011",
"Id": "ca0f63eb-380a-4c45-af17-3490783a663e",
"SequenceNumber": "00000222",
"Message": null,
"ParentId": null,
"HasPortalAccess": false,
"UserName": null,
"CustomFields": {
"Fields": [
{
"Id": "75c2c18d-05d6-4721-a2ea-3d715ced8e23",
"Order": 0,
"Value": "True",
"Description": null,
"Name": "CF Checkbox",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"DefinitionType": 8,
"DefinitionSequenceNumber": 3,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "True",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "32aaaf40-7678-4a1b-893e-5a666992c932",
"Order": 1,
"Value": "123.450000",
"Description": null,
"Name": "CF Decimal",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"DefinitionType": 1,
"DefinitionSequenceNumber": 7,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "123.450000",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": "{\"DecimalPlaces\":2}",
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "0c65e3fb-9fe4-4310-8750-73bdd6cd1fca",
"Order": 2,
"Value": "b2156d17-7156-43fa-b021-200d7a9f2f01",
"Description": null,
"Name": "CF Client",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"DefinitionType": 6,
"DefinitionSequenceNumber": 5,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "Client1 Client1",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": true,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "c2736049-9f3d-44f1-8cc1-2138b995c83c",
"Order": 3,
"Value": "2018-07-04T04:00:00.0000000Z",
"Description": null,
"Name": "CF Datetime",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"DefinitionType": 3,
"DefinitionSequenceNumber": 6,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "7/4/2018 12:00:00 AM",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
}
],
"Sections": [
{
"IsPublic": true,
"OverrideOptions": false,
"Order": 1,
"VisibleIfFieldDefinitionId": null,
"VisibleIfFieldValue": null,
"FieldSectionTemplateId": null,
"FromTemplate": false,
"Rows": [
{
"Order": 0,
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b"
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727"
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9"
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577"
}
]
}
],
"EnglishName": "Additional Information",
"FrenchName": "Informations additionnelles",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "8a7fc779-8f8c-aa8f-6a13-068fa0c931de",
"DescriptionId": "8cd414da-37ff-d618-5eec-45069a96abf1",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000028",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530719174890)/",
"LastModifiedBy": "selenium-tests@c2enterprise.com",
"LastModifiedDateTime": "/Date(1530719174890)/",
"Id": "ced377b7-ea01-fcd2-2703-59de30ac9d7f"
}
]
},
"NameId": "42cd9703-49a3-4534-858c-3fed260c36ed",
"DescriptionId": "3bf98102-b793-48e6-a4f4-c0a25ea82041",
"Data": null,
"ExternalId": null
},
"Message": null,
"Time": "/Date(1530719213516)/"
}
NOTES
- La ressource qui exécute l’appel API doit posséder la permission de créer des CIs dans l’application.
Mettre à jour un item de configuration (CI)
Cet API permet de mettre à jour un billet dans l’application.
URL
{Url_Application}/API/CI/UpdateProperty
Type de requête
POST
Paramètres URL
- Username : nom de la ressource exécutant l’appel API.
- Password : mot de passe de la ressource exécutant l’appel API.
Syntaxe: {Url_Application}/API/CI/UpdateProperty?username=Username&password=Password
Codes de réponse avec succès
- Code de l’entête HTML: 200.
- Code de la réponse JSON: "Status":0,"
Exemple d’appel (champ système)
Les paramètres passés dans l’appel
- « Id » : le Id du CI.
- « PropertyName » : le nom du champ système à mettre à jour.
- « Value » : la nouvelle valeur du champ système.
{
"Id" : "e33ce7a9-cc55-456a-91ec-778c82a4184a",
"PropertyName" : "IsActive",
"Value" : "false",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ système)
{
"Status": 0,
"Data": {
"CINumber": "00000010",
"CICategoryImagePath": null,
"StateId": "3b302329-5610-4ee4-97e9-e8590be84b63",
"CICategoryPrefix": null,
"CITypeId": "9a3084c8-6169-4d0c-8a02-cd93c8913689",
"CategoryId": "eab2c263-6a90-41bd-bdb7-c45a091f9326",
"CIFolderId": "867a0cc0-a85a-4b80-bd69-d0cbb11d051b",
"Name": "CI API",
"CITypeName": "Inventaire",
"IsReadOnly": false,
"CustomFields": {
"Fields": [
{
"Id": "1392670b-d828-4684-bc1d-beaf746ddc10",
"Order": 0,
"Value": "False",
"Description": null,
"Name": "CF Checkbox",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"DefinitionType": 8,
"DefinitionSequenceNumber": 3,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "False",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "f704f86b-5ba9-480d-bd63-241c1454c3f3",
"Order": 1,
"Value": null,
"Description": null,
"Name": "CF Decimal",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"DefinitionType": 1,
"DefinitionSequenceNumber": 7,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": "{\"DecimalPlaces\":2}",
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "98089ce6-5c08-4ff3-a912-2a4308aba62a",
"Order": 2,
"Value": null,
"Description": null,
"Name": "CF Client",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"DefinitionType": 6,
"DefinitionSequenceNumber": 5,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": true,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "21dbf3e2-fad6-462e-a9c6-a72a77bfb6db",
"Order": 3,
"Value": null,
"Description": null,
"Name": "CF Datetime",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"DefinitionType": 3,
"DefinitionSequenceNumber": 6,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": null,
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
}
],
"Sections": [
{
"IsPublic": true,
"OverrideOptions": false,
"Order": 1,
"VisibleIfFieldDefinitionId": null,
"VisibleIfFieldValue": null,
"FieldSectionTemplateId": null,
"FromTemplate": false,
"Rows": [
{
"Order": 0,
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b"
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727"
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9"
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577"
}
]
}
],
"EnglishName": "Additional Information",
"FrenchName": "Informations additionnelles",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "8a7fc779-8f8c-aa8f-6a13-068fa0c931de",
"DescriptionId": "8cd414da-37ff-d618-5eec-45069a96abf1",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000028",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530719174890)/",
"LastModifiedBy": "selenium-tests@c2enterprise.com",
"LastModifiedDateTime": "/Date(1530719174890)/",
"Id": "ced377b7-ea01-fcd2-2703-59de30ac9d7f"
}
]
},
"OwnerId": null,
"OwnerName": null,
"CIRelationsFrom": [],
"CIRelationsTo": [],
"Attachments": [],
"StateTextColor": null,
"StateBackgroundColor": null,
"StateMessage": null,
"Tags": "",
"ExternalId": null,
"CIClientsCount": 0,
"CIEnterprisesCount": 0,
"CITicketsCount": 0,
"EnglishName": "CI API",
"FrenchName": "CI API",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "09761031-a57e-49c5-859a-665416e031a2",
"DescriptionId": "a72a8a85-8baa-4ca0-ad5d-0ed0175832a6",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": false,
"IsDeleted": false,
"SequenceNumber": "00000221",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530719073083)/",
"LastModifiedBy": "admin",
"LastModifiedDateTime": "/Date(1530719715967)/",
"Id": "e33ce7a9-cc55-456a-91ec-778c82a4184a"
},
"Message": null,
"Time": "/Date(1530719716186)/"
}
Exemple d’appel (champ personnalisé)
Les paramètres passés dans l’appel
- « Id » : le Id du CI.
- « CustomFieldSequenceNumber » : le numéro de séquence du champ personnalisé à mettre à jour.
- « Value » : la nouvelle valeur du champ personnalisé.
{
"Id" : "ca0f63eb-380a-4c45-af17-3490783a663e",
"CustomFieldSequenceNumber" : "3",
"Value" : "false",
"username": "admin",
"password": "pax123"
}
Exemple de réponse (champ personnalisé)
{
"Status": 0,
"Data": {
"CINumber": "00000011",
"CICategoryImagePath": null,
"StateId": "3b302329-5610-4ee4-97e9-e8590be84b63",
"CICategoryPrefix": null,
"CITypeId": "9a3084c8-6169-4d0c-8a02-cd93c8913689",
"CategoryId": "eab2c263-6a90-41bd-bdb7-c45a091f9326",
"CIFolderId": "867a0cc0-a85a-4b80-bd69-d0cbb11d051b",
"Name": "CI API2",
"CITypeName": "Inventaire",
"IsReadOnly": false,
"CustomFields": {
"Fields": [
{
"Id": "75c2c18d-05d6-4721-a2ea-3d715ced8e23",
"Order": 0,
"Value": "False",
"Description": null,
"Name": "CF Checkbox",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b",
"DefinitionType": 8,
"DefinitionSequenceNumber": 3,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "False",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "32aaaf40-7678-4a1b-893e-5a666992c932",
"Order": 1,
"Value": "123.450000",
"Description": null,
"Name": "CF Decimal",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727",
"DefinitionType": 1,
"DefinitionSequenceNumber": 7,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "123.450000",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": "{\"DecimalPlaces\":2}",
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "0c65e3fb-9fe4-4310-8750-73bdd6cd1fca",
"Order": 2,
"Value": "b2156d17-7156-43fa-b021-200d7a9f2f01",
"Description": null,
"Name": "CF Client",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9",
"DefinitionType": 6,
"DefinitionSequenceNumber": 5,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "Client1 Client1",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": true,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
},
{
"Id": "c2736049-9f3d-44f1-8cc1-2138b995c83c",
"Order": 3,
"Value": "2018-07-04T04:00:00.0000000Z",
"Description": null,
"Name": "CF Datetime",
"FieldSectionId": "ced377b7-ea01-fcd2-2703-59de30ac9d7f",
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577",
"DefinitionType": 3,
"DefinitionSequenceNumber": 6,
"ListId": null,
"IsRequired": false,
"IsReadOnly": false,
"IsReadOnlyIfHasValue": false,
"IsSecured": false,
"CaseSensitivity": 0,
"InputMask": null,
"MaxLength": null,
"HasTimestampTag": false,
"HasHtmlSupport": true,
"NbLinesHeight": null,
"DisplayName": "7/4/2018 12:00:00 AM",
"HasFilters": false,
"HasFormFilters": false,
"RequiredIfDefinitionId": null,
"RequiredIfBindingName": null,
"RequiredIfValue": null,
"BindingNavigationFieldId": null,
"BindingField": null,
"Options": null,
"TextColor": null,
"BackgroundColor": null,
"ImpactMessage": null,
"Row": null,
"Column": null,
"GridId": null,
"IsActive": false,
"Target": null,
"IsEncrypted": false,
"Cells": null,
"NotReadOnlyGroups": []
}
],
"Sections": [
{
"IsPublic": true,
"OverrideOptions": false,
"Order": 1,
"VisibleIfFieldDefinitionId": null,
"VisibleIfFieldValue": null,
"FieldSectionTemplateId": null,
"FromTemplate": false,
"Rows": [
{
"Order": 0,
"Cells": [
{
"DefinitionId": "e85a893b-6ad3-45a5-a433-0f0f4ee6379b"
},
{
"DefinitionId": "b13533a8-f807-499f-a55e-319023909727"
},
{
"DefinitionId": "4e6d36ce-cb2a-46cd-ab73-1440cb71efa9"
},
{
"DefinitionId": "a6d54b8d-867a-4ef6-a4de-d3d1986f0577"
}
]
}
],
"EnglishName": "Additional Information",
"FrenchName": "Informations additionnelles",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "8a7fc779-8f8c-aa8f-6a13-068fa0c931de",
"DescriptionId": "8cd414da-37ff-d618-5eec-45069a96abf1",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000028",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530719174890)/",
"LastModifiedBy": "selenium-tests@c2enterprise.com",
"LastModifiedDateTime": "/Date(1530719174890)/",
"Id": "ced377b7-ea01-fcd2-2703-59de30ac9d7f"
}
]
},
"OwnerId": null,
"OwnerName": null,
"CIRelationsFrom": [],
"CIRelationsTo": [],
"Attachments": [],
"StateTextColor": null,
"StateBackgroundColor": null,
"StateMessage": null,
"Tags": "",
"ExternalId": null,
"CIClientsCount": 0,
"CIEnterprisesCount": 0,
"CITicketsCount": 0,
"EnglishName": "CI API2",
"FrenchName": "CI API2",
"EnglishDescription": "",
"FrenchDescription": "",
"NameId": "42cd9703-49a3-4534-858c-3fed260c36ed",
"DescriptionId": "3bf98102-b793-48e6-a4f4-c0a25ea82041",
"ImagePath": "/C2ATOM/Content/catalogimages/catalog_other.png",
"IsActive": true,
"IsDeleted": false,
"SequenceNumber": "00000222",
"CreatedBy": "selenium-tests@c2enterprise.com",
"CreatedDateTime": "/Date(1530719213143)/",
"LastModifiedBy": "admin",
"LastModifiedDateTime": "/Date(1530719520687)/",
"Id": "ca0f63eb-380a-4c45-af17-3490783a663e"
},
"Message": null,
"Time": "/Date(1530719520887)/"
}
NOTES
- La ressource qui exécute l’appel API doit posséder la permission de modifier des CIs dans l’application.