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": "ccacb0b3-ab95-40d9-b16b-b46cfc0851de",
"jobs_id": "0b6162d9-1495-4b79-b3df-dcf316d20885",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "10d18925-ec8b-4571-bc9b-a60bf612f7c6",
"_parent_id": "5b5bff49-bd80-4f9c-838e-d572823ed33c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "73f0391b-b0bd-4e56-83ee-1e16d368780d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cd64e92d-6d16-4788-aba2-8420eba8d41e",
"_parent_id": "e4f9621f-ec29-4f69-a956-13f9743ccd91",
"root_parent_id": "9372d451-8f3e-4bc7-b131-b4d3b7a37012",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "73815843-3f02-4df0-a505-86cfafa8dae0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8667584d-b5b1-446c-a55e-db88950decd7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a6cc361-5c04-4336-ae4c-67cf76e96f89",
"_parent_code": "sample string 6",
"sales_organization_id": "ecf12070-9da4-4025-91af-afb0e88f4a1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"modified_dateutc": "2026-10-29T21:33:21.7791767+00:00"
},
"equipment_model_id": "de54c639-99ab-4e43-9d89-fd01b072c303",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c5dda334-e6a0-4dd0-8cb0-5aed6dd614df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1fd579e1-76eb-4dac-9011-8b8c3fe84b12",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "240b2d98-0121-49d7-ac10-11743ec311e1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4eb25b92-f4e1-4bcf-a187-5685c791827b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"modified_dateutc": "2026-10-29T21:33:21.7791767+00:00"
},
"equipment_family_id": "7920c3d3-d204-4cf2-a104-150d225cf778",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8667584d-b5b1-446c-a55e-db88950decd7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a6cc361-5c04-4336-ae4c-67cf76e96f89",
"_parent_code": "sample string 6",
"sales_organization_id": "ecf12070-9da4-4025-91af-afb0e88f4a1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"modified_dateutc": "2026-10-29T21:33:21.7791767+00:00"
},
"date_in_production_since": "2026-10-29T21:33:21.7791767+00:00",
"date_out_of_production_since": "2026-10-29T21:33:21.7791767+00:00",
"date_end_support": "2026-10-29T21:33:21.7791767+00:00",
"sales_organization_id": "c24cd6d9-b654-4d94-9b0b-cc134a097ba1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+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-10-29T21:33:21.7947977+00:00"
},
"project_status_id": "42f71c27-a884-4a5e-8cda-397d9a41cc1f",
"project_status_code": "sample string 10",
"project_status": {
"id": "101c94cf-1c74-43b2-a499-d14c104fa5f3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f9d2cdfc-2f01-4593-88d0-b19a2acec53d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00"
},
"company_id": "8956cb11-a2a3-487d-a0ea-d2e76cb1cda4",
"company_code": "sample string 12",
"db_address_id": "e87f9088-16c0-462a-b7fe-d18b47d98a84",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "833e9334-4e17-4485-bc8c-40b707557496",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "96d15eb8-ec7e-42c2-a6e7-d4290309874c",
"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-10-29T21:33:21.7947977+00:00",
"date_create": "2026-10-29T21:33:21.7947977+00:00",
"date_update": "2026-10-29T21:33:21.7947977+00:00",
"updated_by_user_id": "50b07698-50c8-4808-84c6-5729284f8f30",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-29T21:33:21.7947977+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-10-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-29T21:33:21.7947977+00:00",
"date_last_job": "2026-10-29T21:33:21.7947977+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-29T21:33:21.7947977+00:00",
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00",
"is_mobile_installation": true
},
"job_type_id": "76b098bd-f435-4398-85f3-7823e0c63724",
"job_type_code": "sample string 7",
"job_type": {
"id": "ab0a5610-d1db-455b-a850-43e2ce611cec",
"name": "sample string 2",
"sales_organization_id": "0178274e-69e0-4a52-afcc-567670bff015",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00",
"code": "sample string 7"
},
"job_priority_id": "758e92e7-ff64-476b-987c-5297c68213cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "29d2ac6e-9a12-4129-ae37-c6e30a4bb971",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9498b571-9b8d-4cc5-98ce-a379dcbdad6c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00"
},
"job_status_id": "3905e940-e21a-492d-b61f-1b66ee20b742",
"job_status_code": "sample string 11",
"db_address_id": "ddbe868b-ba41-4e20-9ebf-b04143d760b5",
"contact_id": "af8b17a8-47ca-48c5-92d2-e43df588f5eb",
"requested_by_company_id": "4f7358d9-5eab-4cc6-a536-699fc5c79b93",
"requested_by_contact_id": "839212b5-b833-45dd-9f9b-465a27a43b0d",
"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-10-29T21:33:21.7947977+00:00",
"due_date": "2026-10-29T21:33:21.7947977+00:00",
"date_create": "2026-10-29T21:33:21.7947977+00:00",
"date_update": "2026-10-29T21:33:21.7947977+00:00",
"date_closed": "2026-10-29T21:33:21.7947977+00:00",
"suggested_user_id": "199572b7-cb67-418f-adcc-7aa4b4097a05",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4cc16b14-3f21-49da-8c21-96ef5f1faf2b",
"db_language_id": "63744aa7-2bb0-4664-b9d8-8d686ca19ad3",
"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-10-29T21:33:21.7947977+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59edaa74-9151-4a4a-92a2-e8eab2ae2441",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b01e6b77-a24c-4452-8ff7-f3872f3540f9",
"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": "869344b4-9252-4af7-b950-8f153436d36c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b90b993a-f34d-49cc-a857-360b824331da"
},
"suggested_date_start": "2026-10-29T21:33:21.7947977+00:00",
"skill_id": "0d1a884c-4f0d-421d-80de-9a631f8cf471",
"skill_code": "sample string 32",
"skill": {
"id": "489ca240-5a81-46eb-8920-79b7226dc7e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4025678b-5da4-4745-a001-5b9cb48fbfe4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a0c17a1-1e5b-491f-89f7-e08a97957008",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40219c4d-ef18-4ab4-8ae9-3798426c80d0",
"db_currency_id": "e8799687-aa08-4409-8beb-8e5c78551add",
"db_language_id": "d807f0c4-ad3e-4253-be4f-be84652605d2",
"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-10-29T21:33:21.7636392+00:00"
},
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2dda13e3-a4ba-4a6d-b7dc-1e54e9be00de",
"date_reported_by_company": "2026-10-29T21:33:21.7947977+00:00",
"id2": 36,
"company_id": "1b4a8c71-3499-455b-a041-238201af8587",
"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": "0dc1f146-8e26-48e2-b3ea-d1b036551466",
"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-10-29T21:33:21.7947977+00:00"
},
"work_instruction_details_id": "8767a828-ae91-4618-9ce4-7352c7303d34",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c2c6fdcd-0da7-47cf-bfa7-d8793717b0be",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "278f27c0-8546-4b38-a5eb-9362125ffbf2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-29T21:33:21.7947977+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": "e23fd5e8-6da1-4be1-8c8f-104536ff3577",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-29T21:33:21.7947977+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.