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": "63a988d9-d4d6-406c-a1d0-9a304aa8c3bd",
"jobs_id": "108a906e-749b-4a5c-844d-144ac53fb3de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "87f36d79-ed24-4d52-aa1d-ef39286097b5",
"_parent_id": "40f001bd-acef-46b0-ae70-3d6d1a7f976d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ecd3e2a0-4e87-490b-97fd-21472c6cce17",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b5525b3-72a1-4ce9-9ba9-b03f372ddcdd",
"_parent_id": "e77d7974-c020-4220-833a-be7c6f5d28cd",
"root_parent_id": "8fcb4e8a-3be1-47f3-b300-d32ba75ac206",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2d702bfe-4471-48ab-a41d-2c9bd3089372",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f6182d5b-1dc3-4e68-ad7a-2b0bda33fabe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a39716b-a11f-47b9-b1f4-6f52e8163af5",
"_parent_code": "sample string 6",
"sales_organization_id": "ed28b85d-e66a-4b60-b661-d819847766ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"equipment_model_id": "6ba4e1db-53d9-4249-bef6-f8e912ee1ad6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "edace6de-7f61-4587-9300-83d52e989fed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "58c2db86-d237-40ee-9bbd-5424a0023254",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d06d196f-d9eb-4ab4-8ea2-3a2f9ef35bbc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "82e4e5cb-3643-4b83-aa48-619b47799d45",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"equipment_family_id": "77fe3ff0-44a1-4431-a2a8-a434081f9e17",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f6182d5b-1dc3-4e68-ad7a-2b0bda33fabe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a39716b-a11f-47b9-b1f4-6f52e8163af5",
"_parent_code": "sample string 6",
"sales_organization_id": "ed28b85d-e66a-4b60-b661-d819847766ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"date_in_production_since": "2026-02-20T15:19:01.3770466+00:00",
"date_out_of_production_since": "2026-02-20T15:19:01.3770466+00:00",
"date_end_support": "2026-02-20T15:19:01.3770466+00:00",
"sales_organization_id": "b6eb2d33-40af-4765-8e13-fa0a03babce0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+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-02-20T15:19:01.3770466+00:00"
},
"project_status_id": "d5c442d4-77d5-4da4-89b2-9529683561a2",
"project_status_code": "sample string 10",
"project_status": {
"id": "15485701-cd13-4b33-a0e4-c5d9555490e7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "49b550a1-c4af-4879-ac48-d582cccdcbd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"company_id": "8e500a82-d369-43ef-a69b-dd80d4b14e7b",
"company_code": "sample string 12",
"db_address_id": "466001cf-fd92-40e8-91b6-bf53547a8964",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5d16123c-f1ec-4667-a64d-adee1706850e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8e21394e-1c23-4b74-b834-f384a1169995",
"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-02-20T15:19:01.3770466+00:00",
"date_create": "2026-02-20T15:19:01.3770466+00:00",
"date_update": "2026-02-20T15:19:01.3770466+00:00",
"updated_by_user_id": "26c75091-1215-43ad-8a13-f087cf1d67a4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-20T15:19:01.3770466+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-02-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-20T15:19:01.3770466+00:00",
"date_last_job": "2026-02-20T15:19:01.3770466+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-20T15:19:01.3770466+00:00",
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00",
"is_mobile_installation": true
},
"job_type_id": "704bc994-4776-4ceb-bed2-b2b2a7ae0ede",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ab975e1-2648-43b3-861a-bf3ab90bb906",
"name": "sample string 2",
"sales_organization_id": "4ba9c894-4d9d-4e52-9c8d-0875ad4732ab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00",
"code": "sample string 7"
},
"job_priority_id": "a82175a2-2ce0-445d-bcb9-c7ace1886dc0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "abc09c08-e663-4aeb-b1a0-e49ed39d32e2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e00012e6-7904-44af-960d-897f5b39d13b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"job_status_id": "9b09e266-17c4-491b-9383-c5363d0ae2e6",
"job_status_code": "sample string 11",
"db_address_id": "d6f9b4e5-406f-4519-9206-2bea4c227eed",
"contact_id": "0c0c795a-b8cb-4c37-8b71-cccd203bed5f",
"requested_by_company_id": "bc98ae14-3698-4fa7-8791-4ce703a36f67",
"requested_by_contact_id": "c1c830de-e0a6-4751-ba3e-26dc001e213a",
"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-02-20T15:19:01.3770466+00:00",
"due_date": "2026-02-20T15:19:01.3770466+00:00",
"date_create": "2026-02-20T15:19:01.3770466+00:00",
"date_update": "2026-02-20T15:19:01.3770466+00:00",
"date_closed": "2026-02-20T15:19:01.3770466+00:00",
"suggested_user_id": "4fc68be1-d355-44b1-a299-5d5775f4a422",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2bfbb502-9f1c-486c-9c3b-50d4c7278136",
"db_language_id": "d69718bb-7d84-47df-a1bd-7260cb3a3680",
"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-02-20T15:19:01.3770466+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fda5f86a-f9d2-432d-bf8b-fc5a327f8456",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c84f967f-d799-4e64-b33f-c1e84b846547",
"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": "352f992f-1388-4760-8c1a-86397b9e8966",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6c191236-8cae-495c-b43a-be97cd8af77c"
},
"suggested_date_start": "2026-02-20T15:19:01.3770466+00:00",
"skill_id": "9b0d3ed6-a453-4e36-8dc6-7c030e89189d",
"skill_code": "sample string 32",
"skill": {
"id": "b4211395-7e86-4775-ad91-8a7a8482d5d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a0afd4f4-1253-47e9-8b8e-315e578482b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee8ee58c-8087-4121-aa45-b7a3435856e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ec0a3e5-8fad-4e82-ac22-a1f6fb327213",
"db_currency_id": "638567e5-0b78-45ee-8e03-1b5a0bb01d0d",
"db_language_id": "260b1f80-5a00-4402-9ad5-235996cfab25",
"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-02-20T15:19:01.3770466+00:00"
},
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7644fd65-8be1-4f33-95c3-0632c73696c9",
"date_reported_by_company": "2026-02-20T15:19:01.3770466+00:00",
"id2": 36,
"company_id": "f9a26eb4-8dd3-4b64-974f-ed66862a7906",
"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": "413196ef-991b-4b07-89f1-677d034cc147",
"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-02-20T15:19:01.3770466+00:00"
},
"work_instruction_details_id": "62634468-f2bf-4015-9230-a9f000764613",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "058b6897-0f4b-4c32-baa8-85231598aff5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "04c0f2f6-082a-4970-81f6-773324d2d5a4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-20T15:19:01.3770466+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": "9eee9820-7eb3-4680-929b-9039dd82a13f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-20T15:19:01.3770466+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.