Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "5b77733e-9039-4ed7-8c60-68311c9c0046",
"jobs_id": "92e3e130-9dd8-43ca-9f9d-d138158d4168",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d23ea279-3987-4919-9b8c-9f12c18fdedf",
"_parent_id": "ec853c73-16cd-4788-9bcf-b42d6ab02b1c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0a9a53d1-febc-4568-a0ae-ec3322fd5c34",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8eae2b1a-78ad-4f85-a48a-fd921be8d5fe",
"_parent_id": "886bd6b6-397a-4a7b-a519-0e7d85a6bcf7",
"root_parent_id": "14a82a5a-1460-476c-a615-51cc74882836",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c092bfcc-cc40-4a41-9538-4a29371fd06b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de688186-38d5-4d50-a02a-7b0163302bfa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecde005f-9bb0-44ac-a918-eb225dd81daa",
"_parent_code": "sample string 6",
"sales_organization_id": "268fa957-cbe9-41d2-8162-642c678d7035",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"equipment_model_id": "81417b04-12b1-42b0-979e-e3fe00f11612",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e27e96b3-4fad-4dde-88ff-60621208e77e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2436c03f-07f8-4645-a2da-47e457fa405c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "af278243-7bab-4e3c-a927-879057c3a507",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3af3fce6-1bf5-43b4-a9c1-fbb7d270e52b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"equipment_family_id": "9fc5035f-cc1d-4c3d-9713-4ce74c080f49",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de688186-38d5-4d50-a02a-7b0163302bfa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecde005f-9bb0-44ac-a918-eb225dd81daa",
"_parent_code": "sample string 6",
"sales_organization_id": "268fa957-cbe9-41d2-8162-642c678d7035",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"date_in_production_since": "2026-05-10T12:00:09.0796976+00:00",
"date_out_of_production_since": "2026-05-10T12:00:09.0796976+00:00",
"date_end_support": "2026-05-10T12:00:09.0796976+00:00",
"sales_organization_id": "5b4ddbc0-b347-4df8-88c1-17b85f97ab91",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+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-05-10T12:00:09.0796976+00:00"
},
"project_status_id": "8c830ad3-b34a-4685-b712-f006a478fc3d",
"project_status_code": "sample string 10",
"project_status": {
"id": "71533e47-c681-4c78-b01e-b45b0e05ef95",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "156a8c56-24c7-473c-8235-b3bc14253d15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"company_id": "30f89033-f454-47d6-95b6-518b6e7f9c16",
"company_code": "sample string 12",
"db_address_id": "85dc6858-6810-4a91-8b8a-b279a27f4878",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd48b3b1-7472-471d-b555-b90b86b81489",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b97cb497-f222-4854-baf3-3526349d476b",
"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-05-10T12:00:09.0796976+00:00",
"date_create": "2026-05-10T12:00:09.0796976+00:00",
"date_update": "2026-05-10T12:00:09.0796976+00:00",
"updated_by_user_id": "50a97043-761c-4937-92c7-31e46c1119c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-10T12:00:09.0796976+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-05-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-10T12:00:09.0796976+00:00",
"date_last_job": "2026-05-10T12:00:09.0796976+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-10T12:00:09.0796976+00:00",
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00",
"is_mobile_installation": true
},
"job_type_id": "86d039f2-0c04-4017-aa9f-0a153107cc41",
"job_type_code": "sample string 7",
"job_type": {
"id": "c2a69c62-b551-4a34-8a7a-f3d17e3b0d97",
"name": "sample string 2",
"sales_organization_id": "1b3805e5-9b85-40b0-ba02-c2c728b7f07c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00",
"code": "sample string 7"
},
"job_priority_id": "89e9c3c6-e60c-4d35-8287-e2e4194c86ab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f26e874c-8a95-4198-aa97-70995396948b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3ed4d892-7fa5-4912-bf14-fc736faff522",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"job_status_id": "bac04466-68f5-411d-b97a-0e85e094e5fa",
"job_status_code": "sample string 11",
"db_address_id": "3e538ac6-0af5-4ee1-acac-2acfd07af4ae",
"contact_id": "d861bb0d-bb11-40c9-b192-461fe6720c85",
"requested_by_company_id": "db513473-03bb-4384-8d2c-0f9a65a08c72",
"requested_by_contact_id": "dbc4f8db-b9f0-4e47-a70e-536ff04e43a3",
"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-05-10T12:00:09.0796976+00:00",
"due_date": "2026-05-10T12:00:09.0796976+00:00",
"date_create": "2026-05-10T12:00:09.0796976+00:00",
"date_update": "2026-05-10T12:00:09.0796976+00:00",
"date_closed": "2026-05-10T12:00:09.0796976+00:00",
"suggested_user_id": "20775150-7ed8-4877-82ce-f5c7ea253bbd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8fde5468-2e0e-480f-a37a-4f268badbc9c",
"db_language_id": "9a7e8fb0-821a-49f2-a4ff-3640bdd9345d",
"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-05-10T12:00:09.0796976+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b643a1ed-c95c-4676-98bb-b0f97bee2e74",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "451094cf-f2a0-4ac5-87b5-164dafed70bf",
"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": "275fc62c-7b8e-4478-bdfe-f5a81a31f40e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "79581f11-110d-439e-b223-1ce1271a91d1"
},
"suggested_date_start": "2026-05-10T12:00:09.0796976+00:00",
"skill_id": "ddeed6be-edd6-4a91-a132-15cad973a208",
"skill_code": "sample string 32",
"skill": {
"id": "521a341a-b0f4-42d1-8816-ecf88338025c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "df72dd54-7adf-4e1a-bc1d-cc0528d2286f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51348880-de6e-4ec8-a5a2-7b6359512cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566866e5-ae67-49ba-8d0e-2b8cda5c1034",
"db_currency_id": "c1e251be-ef74-41bc-897c-23a9e73e2404",
"db_language_id": "152de5c5-ba56-4e92-9746-543438678ffd",
"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-05-10T12:00:09.0796976+00:00"
},
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "680dca61-76f3-4eec-9b31-c8169a1ec089",
"date_reported_by_company": "2026-05-10T12:00:09.0796976+00:00",
"id2": 36,
"company_id": "a6c6e3b9-7a07-48ad-8ab0-c835df778ab8",
"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": "1dc1c06b-8fb6-4222-bdad-45e5faf87923",
"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-05-10T12:00:09.0796976+00:00"
},
"work_instruction_details_id": "ec10e828-eecf-401e-bdaa-88416a6bcaa6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ef1c87ff-8170-4891-a791-d9771789edb5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "13578e44-24b5-48a2-9d05-16e3b525ba14",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-10T12:00:09.0796976+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "890ff260-f232-4ab1-9602-b9156b5ab6b1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-10T12:00:09.0796976+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.