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": "7e4a22c4-ecfc-45d3-a5c6-00491efa09c1",
"jobs_id": "07b8707a-0a05-46be-a098-0a24990929d8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed70e72e-a865-41ab-8461-39fed264cf5e",
"_parent_id": "4841d426-312d-433c-a1c8-47e5a10789e2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b3ff2715-5a10-4468-b636-15870c2fb91e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "392d8628-43a1-4aa3-a5b4-19520667f35d",
"_parent_id": "2ce2a913-dc74-42b1-bd63-8f2425a21250",
"root_parent_id": "fd15841f-ce34-4d30-a25e-6bda189a6fb1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1db5ae75-81a9-4e55-a20b-868b51910e3b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f056e786-5ba4-4b72-a20e-0cbd5b66169f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8bd27188-cb6c-4504-abc6-d54f71346bf2",
"_parent_code": "sample string 6",
"sales_organization_id": "d1fffbbb-84ed-4175-b115-08e9777be186",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"modified_dateutc": "2026-01-19T14:08:20.7837273+00:00"
},
"equipment_model_id": "c8b54456-b120-4351-9a60-c60986da9dc0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9e83a4fd-8866-4dbf-91b0-a1e4bd4f61d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1cdaa349-75c4-4be8-8ba3-37c9d1c26b8f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "93139c2b-eec4-4e5d-b62a-9c86ee22e721",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6fb364fb-142c-49b7-bcb5-5c6b9144b284",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"modified_dateutc": "2026-01-19T14:08:20.7837273+00:00"
},
"equipment_family_id": "99084b0e-66b5-4fdc-a255-6602448e5284",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f056e786-5ba4-4b72-a20e-0cbd5b66169f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8bd27188-cb6c-4504-abc6-d54f71346bf2",
"_parent_code": "sample string 6",
"sales_organization_id": "d1fffbbb-84ed-4175-b115-08e9777be186",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"modified_dateutc": "2026-01-19T14:08:20.7837273+00:00"
},
"date_in_production_since": "2026-01-19T14:08:20.7993524+00:00",
"date_out_of_production_since": "2026-01-19T14:08:20.7993524+00:00",
"date_end_support": "2026-01-19T14:08:20.7993524+00:00",
"sales_organization_id": "08ad00d4-e2e8-4ad4-ad65-516dd194fdda",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+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-01-19T14:08:20.7993524+00:00"
},
"project_status_id": "c30ce3d1-9e32-41e3-a1db-a6ccda597350",
"project_status_code": "sample string 10",
"project_status": {
"id": "b4378354-301e-44f7-830c-54961335b2ef",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "99f37d30-a749-4989-be22-d2a851c15b1c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00"
},
"company_id": "192883e7-4312-4fc3-9020-9aaac4760727",
"company_code": "sample string 12",
"db_address_id": "0b4ea2fa-c111-4083-bf6d-544458c5beb3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8fffd33d-d3e4-4459-b601-5cfbe79c9330",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb644c3c-81f3-49e0-bd18-d43caf84c7ec",
"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-01-19T14:08:20.7993524+00:00",
"date_create": "2026-01-19T14:08:20.7993524+00:00",
"date_update": "2026-01-19T14:08:20.7993524+00:00",
"updated_by_user_id": "d90d3238-cbee-4d12-b2b1-deb326781cbd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T14:08:20.7993524+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T14:08:20.7993524+00:00",
"date_last_job": "2026-01-19T14:08:20.7993524+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T14:08:20.7993524+00:00",
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00",
"is_mobile_installation": true
},
"job_type_id": "a040dc14-10b9-4fcd-bc41-00fe9193507e",
"job_type_code": "sample string 7",
"job_type": {
"id": "416430b1-a201-413d-80e1-5895d12f91be",
"name": "sample string 2",
"sales_organization_id": "5f8ab2ef-223c-4608-8664-d69ab18f558b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00",
"code": "sample string 7"
},
"job_priority_id": "f81aad64-4787-4220-8b6e-5f05c2476f9f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ebae98b-0d48-4dac-950a-f8533fbbddbc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4a81672a-7631-4f45-b965-3c79962922c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00"
},
"job_status_id": "51fca86e-15ef-4c06-9e29-829734294328",
"job_status_code": "sample string 11",
"db_address_id": "02644304-7a43-49be-9474-3fa3681c6fc3",
"contact_id": "17c0d7a2-91ee-4197-9cea-5cda0443e060",
"requested_by_company_id": "59394cdc-bafc-4f83-94cc-c731f267f8f9",
"requested_by_contact_id": "0fd544ac-9468-472a-a89a-6657fa702259",
"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-01-19T14:08:20.7993524+00:00",
"due_date": "2026-01-19T14:08:20.7993524+00:00",
"date_create": "2026-01-19T14:08:20.7993524+00:00",
"date_update": "2026-01-19T14:08:20.7993524+00:00",
"date_closed": "2026-01-19T14:08:20.7993524+00:00",
"suggested_user_id": "2dda3fbd-8a4f-4c9a-bef3-72ac3945ec4e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "57343ce1-9fad-471c-be88-cee89f50b725",
"db_language_id": "51905834-f8a8-41e9-8b37-fc0291a4fa67",
"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-01-19T14:08:20.7993524+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a046009-17b4-45bb-9a06-cbe16335e2e3",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "416a438a-0cb4-48b7-bc7e-02758e6d3a5e",
"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": "37cda901-b55c-4f25-b69a-212ea161b738",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c73e9609-0e2d-46a8-82f3-605258880c88"
},
"suggested_date_start": "2026-01-19T14:08:20.7993524+00:00",
"skill_id": "be9ed443-cd59-4772-ba44-4daeccd89931",
"skill_code": "sample string 32",
"skill": {
"id": "09e9ebd3-5d96-4e1b-a4ed-9cc1b45ab924",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0018c34f-7935-46ef-9090-e8943836ef4b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c679f49-eea0-49db-8559-1f17f46f8b69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b01dcc0e-a212-45e3-b441-70babd0307bd",
"db_currency_id": "5ab0e22f-2f49-450e-9140-e0181583cf75",
"db_language_id": "22bad660-b0d9-4aa0-9ca4-bf60c64a722c",
"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-01-19T14:08:20.7837273+00:00"
},
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2371c179-4f23-4cc5-a259-4022328b32b5",
"date_reported_by_company": "2026-01-19T14:08:20.7993524+00:00",
"id2": 36,
"company_id": "fc68e468-8205-4c2b-a8bc-848a6ccfaf97",
"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": "3673fb64-ae72-4b98-9317-83354461e4dd",
"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-01-19T14:08:20.7993524+00:00"
},
"work_instruction_details_id": "725253f0-1914-4483-a341-df588bab01a0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "df1bc73d-154e-4149-93aa-ccbee91f1ec0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8b170257-ae3e-40aa-846f-571601c67ab7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T14:08:20.7993524+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": "334c2638-ba49-4e31-aacf-141672ff42d1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T14:08:20.7993524+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.