Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobsName | 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": "ca41b7b2-a1be-4825-ba8b-89937f313415", "_parent_id": "a54d3c00-23a3-452c-830a-38a35e72e254", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "6c52ca0a-5705-461d-b646-de80050f6c6f", "project_reference_back_office": "sample string 5", "project": { "id": "d207ce93-8145-47a2-9b05-bcd3744f72cb", "_parent_id": "eb32be19-4b8d-4c90-b8d1-50c60d35c08c", "root_parent_id": "f86808cf-cdc6-477c-9ce7-711dffa43b3c", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "6ef0a974-83e7-4539-a09a-f5ef8afe005b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "c907cf08-510e-46ea-895e-70774ffd92db", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a170bdee-4a5e-4387-9dc1-a71c66a710c1", "_parent_code": "sample string 6", "sales_organization_id": "22008aa6-a738-40fa-aa37-a3af00681839", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "equipment_model_id": "07ce1f09-f457-4597-8f1a-39c4b0aa24c1", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f05de116-68da-4f58-a8cc-2c4f8904a590", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "8714494e-1de0-4c07-924f-49ffa490ecb9", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "44643981-419a-4efb-8dd4-fa437e11b21d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "364653c0-ce65-4eca-a5ae-f687ab8c0e45", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "equipment_family_id": "0c074fb8-58d5-44bf-a740-ae72647d19a2", "equipment_family_code": "sample string 8", "equipment_family": { "id": "c907cf08-510e-46ea-895e-70774ffd92db", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a170bdee-4a5e-4387-9dc1-a71c66a710c1", "_parent_code": "sample string 6", "sales_organization_id": "22008aa6-a738-40fa-aa37-a3af00681839", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "date_in_production_since": "2025-06-07T23:22:32.8428072+00:00", "date_out_of_production_since": "2025-06-07T23:22:32.8428072+00:00", "date_end_support": "2025-06-07T23:22:32.8428072+00:00", "sales_organization_id": "6f43fd22-2a3b-4b92-88cd-aef73a4d32e1", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+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": "2025-06-07T23:22:32.8428072+00:00" }, "project_status_id": "b010bc4a-d578-4b9b-b112-e1999eb63b95", "project_status_code": "sample string 10", "project_status": { "id": "184c9273-03cf-41a1-a7f0-c974d042cb80", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "24c704b2-759d-46b9-8c89-9cda6f578a56", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "company_id": "3e7c05e4-634a-4e46-8d7c-acd85bc7faf4", "company_code": "sample string 12", "db_address_id": "24b025f2-6878-4b5b-8c63-e6a6aa6ce836", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "8305dc8f-9f44-4d28-868f-415886f91840", "contact_reference_back_office": "sample string 17", "owner_user_id": "f9433218-82b2-42c6-8b1f-d5b37fda0ad9", "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": "2025-06-07T23:22:32.8428072+00:00", "date_create": "2025-06-07T23:22:32.8428072+00:00", "date_update": "2025-06-07T23:22:32.8428072+00:00", "updated_by_user_id": "83256ca5-0154-4564-a09c-a424da5fab7a", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-07T23:22:32.8428072+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": "2025-06-07T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-07T23:22:32.8428072+00:00", "date_last_job": "2025-06-07T23:22:32.8428072+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-07T23:22:32.8428072+00:00", "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00", "is_mobile_installation": true }, "job_type_id": "37e372de-1ec6-4d72-b5c2-cf80c9415dfe", "job_type_code": "sample string 7", "job_type": { "id": "f0c4a2a2-0a32-41e1-9aea-bd42d9d2a125", "name": "sample string 2", "sales_organization_id": "c4fffadf-628f-463d-a3bf-1d848535d80c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00", "code": "sample string 7" }, "job_priority_id": "6e5b9302-219c-4288-a4a4-8437d044aafa", "job_priority_code": "sample string 9", "job_priority": { "id": "5f41d487-4c74-48e6-93a7-62f5b281ad80", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9ae15097-2eeb-4556-a907-a854fd2450a5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "job_status_id": "34d12e12-649e-4c9f-8aed-fbf2f6f9ee9b", "job_status_code": "sample string 11", "db_address_id": "541d14c0-a236-406a-8f74-97a5c2ac7700", "contact_id": "3e8af809-792a-498b-92d9-d80bc6a58937", "requested_by_company_id": "887a69dd-6f55-4a6c-8e90-4b87293433d2", "requested_by_contact_id": "fb6b1c9c-5e15-4825-b636-9ec856fa903c", "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": "2025-06-07T23:22:32.8428072+00:00", "due_date": "2025-06-07T23:22:32.8428072+00:00", "date_create": "2025-06-07T23:22:32.8428072+00:00", "date_update": "2025-06-07T23:22:32.8428072+00:00", "date_closed": "2025-06-07T23:22:32.8428072+00:00", "suggested_user_id": "781ff109-173d-42f3-9fdd-37cc65ecd9a3", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6c9cd359-5454-4c7d-bd54-0ec5c23b02c9", "db_language_id": "10d62e0b-6a96-432c-98d5-eb8c0392f069", "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": "2025-06-07T23:22:32.8428072+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "506f523a-fdcf-4d5e-b183-8a2f809439f1", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "325b3008-2be8-4d44-a57c-07bc9ed80727", "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": "b4ee8a96-9f64-44ad-bba9-ad7c342aca67", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "16a2dd3a-bc36-460b-bd24-fddfeb0d047b" }, "suggested_date_start": "2025-06-07T23:22:32.8428072+00:00", "skill_id": "3d03342e-1f6f-4fc0-860e-4cb1099fe3af", "skill_code": "sample string 32", "skill": { "id": "d0257020-5215-4da6-bf89-fea4363de1da", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "1386b2b8-9af3-4013-8a61-4144c467a14d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c7fe3561-7e2c-41a8-814d-526c42ac3e1b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b377f9b-bda7-4780-b9d1-7dc012efe75a", "db_currency_id": "614daaba-db6e-4dee-8d11-eafcc35f58e9", "db_language_id": "a4dac84b-2135-47eb-bf1e-31dbea2a77cf", "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": "2025-06-07T23:22:32.8428072+00:00" }, "modified_dateutc": "2025-06-07T23:22:32.8428072+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "06eb6a5b-df21-44d5-a508-87143161e5b5", "date_reported_by_company": "2025-06-07T23:22:32.8428072+00:00", "id2": 36, "company_id": "1158769b-6a85-4910-bae7-e8f62b5063ec", "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": "843955d6-cc35-480c-9eb5-9ad5fa3ed2bb", "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": "2025-06-07T23:22:32.8428072+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.