Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobs| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| _parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
| _parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
| _parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
| project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
| job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
| job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
| job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
| job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
| job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
| db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
| contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
| requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
| requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
| reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
| name |
Name of the Job |
string |
Required Max length: 255 |
| description |
Description of the job |
string |
Max length: 4000 |
| working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
| internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
| prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
| estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
| earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
| due_date |
Deadline of Max date for the planning (Not After) |
date | |
| date_create |
Creation date+time |
date | |
| date_update |
Update date+time |
date | |
| date_closed |
Date+time job goes to completed |
date | |
| suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
| suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
| suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
| suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
| skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
| skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
| skill |
Embedded entity "skill" when adding/updating job |
skill | |
| customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
| approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
| date_reported_by_company |
Date+time when company reported the problem |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
| company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
| company_code |
This field will be filled automatically based on the project_id |
string | |
| db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
| db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_street2 |
It is sub street |
string |
Max length: 50 |
| db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
| db_address_db_country_code |
When mobile equipment, the address to use |
string | |
| db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
| db_address_latitude_decimal |
Latitude |
decimal number | |
| db_address_longitude_decimal |
Latitude |
decimal number | |
| estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "68a39c9b-2352-46ad-aa37-8a6a8ee225b2",
"_parent_id": "efcfaf0f-303f-48d5-8936-8d52b8f98537",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4082e03e-2e3c-428f-96e3-a502de3adf13",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d2d96725-27e6-4a51-91a5-0ab9eec73c2c",
"_parent_id": "53e9a879-d0ba-446d-a078-79707de821c2",
"root_parent_id": "10d00bb8-16fa-45f3-baa6-6add1bc93da5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "125ff203-19de-4017-a734-41bb07d22f9d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "70bcc939-1e77-4a61-b23a-eb7e55d54226",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0c236a5e-57b9-4f8f-8cfe-ff8b447e80b7",
"_parent_code": "sample string 6",
"sales_organization_id": "4fb18508-43e5-4261-8970-c5ba5918e058",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"equipment_model_id": "62d3f7c7-7490-451d-8e1e-2366ffb3e2a8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "30260444-3d62-4239-bba5-307c75899225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f6b668dd-ca4f-42c0-9213-815877265d0a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4c1e5ec0-3b0c-4256-ad9e-eb27e0cb9ece",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3e7cc307-0cc8-4d3b-8beb-0c6168f46ea2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"equipment_family_id": "01a4c466-feb2-41a9-9ead-e1e6ea12333b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "70bcc939-1e77-4a61-b23a-eb7e55d54226",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0c236a5e-57b9-4f8f-8cfe-ff8b447e80b7",
"_parent_code": "sample string 6",
"sales_organization_id": "4fb18508-43e5-4261-8970-c5ba5918e058",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"date_in_production_since": "2026-07-08T02:00:52.6371868+00:00",
"date_out_of_production_since": "2026-07-08T02:00:52.6371868+00:00",
"date_end_support": "2026-07-08T02:00:52.6371868+00:00",
"sales_organization_id": "8b5fdfa1-b2c6-457f-896e-bef24105389a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"project_status_id": "0d13c92d-c9cb-423a-9007-cd1dc07ea967",
"project_status_code": "sample string 10",
"project_status": {
"id": "8adbcf09-dbb5-4066-835f-750182c31ac0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e7bce6bc-1102-4cd4-aa9f-e5eeeccd7560",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"company_id": "3db57c34-5c5f-4a44-b935-b7d9340a6e65",
"company_code": "sample string 12",
"db_address_id": "da8bbaaa-1326-44b2-b789-d6f4440fa248",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11c6b213-f587-420a-863d-bb35039c540e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f87c12eb-f571-4903-bb4a-9ccaa4a502ee",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-07-08T02:00:52.6371868+00:00",
"date_create": "2026-07-08T02:00:52.6371868+00:00",
"date_update": "2026-07-08T02:00:52.6371868+00:00",
"updated_by_user_id": "bceab5f8-a936-48da-86fc-5bb3a32df97a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T02:00:52.6371868+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T02:00:52.6371868+00:00",
"date_last_job": "2026-07-08T02:00:52.6371868+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T02:00:52.6371868+00:00",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00",
"is_mobile_installation": true
},
"job_type_id": "e966a182-f021-4fda-ae24-ad1b4fc4abf1",
"job_type_code": "sample string 7",
"job_type": {
"id": "3ed81127-665f-4974-842c-66890d720da6",
"name": "sample string 2",
"sales_organization_id": "39c06f0d-d8aa-4bec-b134-0e6d076a05ad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00",
"code": "sample string 7"
},
"job_priority_id": "c74ad915-f491-4286-acbd-2751615c40ef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fef25225-d4e2-4d66-ad68-eb8b6850e955",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d5cab08e-acea-424d-bd2e-392b8467ed56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"job_status_id": "1e7edc35-6baf-49db-ba52-3536b4f12aef",
"job_status_code": "sample string 11",
"db_address_id": "6640657a-9e91-4709-839f-11ab368eaf22",
"contact_id": "05c178c8-4b50-42f1-ad63-16d4eb9bf709",
"requested_by_company_id": "bc44bfc1-2dcb-4c79-9d60-39367146d836",
"requested_by_contact_id": "81ca128f-a7c4-4924-9d8b-229406ad3adc",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-07-08T02:00:52.6371868+00:00",
"due_date": "2026-07-08T02:00:52.6371868+00:00",
"date_create": "2026-07-08T02:00:52.6371868+00:00",
"date_update": "2026-07-08T02:00:52.6371868+00:00",
"date_closed": "2026-07-08T02:00:52.6371868+00:00",
"suggested_user_id": "80dffa96-2058-49b3-923a-4fb6b254c1a0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "08cded14-4279-4c20-923f-76dedf44d07f",
"db_language_id": "b79d70d2-f351-434b-9049-e95cb9ba3f64",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-07-08T02:00:52.6528181+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4d4c5aa2-ef8a-489c-8910-00b289a49934",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "38fa0522-7c13-44df-a4a0-431309869277",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "e64949d2-084e-4995-955a-f40469ddc44c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T02:00:52.6528181+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c075e1e0-8304-446c-8c67-9992de99d20f"
},
"suggested_date_start": "2026-07-08T02:00:52.6528181+00:00",
"skill_id": "efb343e1-3a3c-4b73-9978-ef229cd8ac8b",
"skill_code": "sample string 32",
"skill": {
"id": "ab4ce0b9-30f6-4205-8a6f-43474fb55fa3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4858cde-8a14-4a28-ad85-bcbe4b16ff46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed284889-8190-40dd-a191-f7e430ae7263",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f3644c-a7b7-4a37-82c8-d90abf5acf99",
"db_currency_id": "8b86a927-0f87-485a-8fc7-404964640250",
"db_language_id": "3aba090d-0097-42fb-81b7-3cc90e296949",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T02:00:52.6371868+00:00"
},
"modified_dateutc": "2026-07-08T02:00:52.6528181+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "06cd679a-3e84-419c-b118-7995242178c2",
"date_reported_by_company": "2026-07-08T02:00:52.6528181+00:00",
"id2": 36,
"company_id": "8fc23f49-141b-4790-b25e-8f12187a91ad",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "0f0d4073-051c-4d96-b0fd-665ec512b5ac",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-07-08T02:00:52.6528181+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.