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": "e0092634-ff74-4a3b-9065-6aefb5dcec5e",
"jobs_id": "f50c018d-5d97-4a2e-b41c-a76a07c57c95",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2c84a7c5-e2e3-489f-86f7-ed3c4fb9ed0d",
"_parent_id": "e7ef226d-cd8b-4c4c-b381-f7c2e51d23cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a2d01ebe-a03c-4533-a746-d60870b04cf2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04aefde6-90ba-44ca-8491-56d2c93f2c9b",
"_parent_id": "fa395fa2-24d3-4703-9956-3438e2ac4108",
"root_parent_id": "2f530e71-159c-4af1-a2ba-5c8765d1ad7d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15f4d165-44e7-4e7c-8dd3-46cbe496aba1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f74a9647-c093-4b92-8d0b-418056ca2fbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fffcd358-fbe1-455e-9fc8-c5534af92abe",
"_parent_code": "sample string 6",
"sales_organization_id": "6aa09e7a-b522-4048-9818-3465d317c085",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"equipment_model_id": "1f0c0cfc-c2bd-4b3c-b855-66dc8e3cac04",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "26cdbb0d-aa81-4088-ad95-2bc250edb09f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e8efc2a0-9ccd-43fd-af82-4facff02d65a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bdff29f3-71a4-47b8-9341-2d27264f2b2c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "45b7752d-610d-4a0c-89c6-2ba0a8812081",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"equipment_family_id": "7c64a197-e45e-4822-b283-cbc091fbea01",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f74a9647-c093-4b92-8d0b-418056ca2fbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fffcd358-fbe1-455e-9fc8-c5534af92abe",
"_parent_code": "sample string 6",
"sales_organization_id": "6aa09e7a-b522-4048-9818-3465d317c085",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"date_in_production_since": "2026-08-06T19:59:45.4378259+00:00",
"date_out_of_production_since": "2026-08-06T19:59:45.4378259+00:00",
"date_end_support": "2026-08-06T19:59:45.4378259+00:00",
"sales_organization_id": "0ffae7d5-e526-4ae9-b6f4-b4e580030b1b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+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-08-06T19:59:45.4378259+00:00"
},
"project_status_id": "0e3104bf-113a-4f5e-b1d1-7786fe045b54",
"project_status_code": "sample string 10",
"project_status": {
"id": "d1c87985-974b-4ae9-beaa-dd7f6de21e1e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e500a2fa-d6ad-4a44-9518-18739b78bc2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"company_id": "1b2c6ce6-33f1-4425-88a0-f146a8fc5d08",
"company_code": "sample string 12",
"db_address_id": "410af549-14d5-4bb7-859d-77ee09db4508",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "85b9dcab-f288-4947-b5ee-43473ec38295",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "25d9b433-8d97-43b8-ab52-070dca6ddf8e",
"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-08-06T19:59:45.4378259+00:00",
"date_create": "2026-08-06T19:59:45.4378259+00:00",
"date_update": "2026-08-06T19:59:45.4378259+00:00",
"updated_by_user_id": "6797ce7d-ef8f-4d58-8972-59e2a37c2c65",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T19:59:45.4378259+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-08-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T19:59:45.4378259+00:00",
"date_last_job": "2026-08-06T19:59:45.4378259+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T19:59:45.4378259+00:00",
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00",
"is_mobile_installation": true
},
"job_type_id": "e31bdea6-30d6-4b88-83e0-3e4f4d00e83e",
"job_type_code": "sample string 7",
"job_type": {
"id": "a86f7388-b1d1-48fc-b585-81751d058a16",
"name": "sample string 2",
"sales_organization_id": "c40b67ad-af6f-446e-ac66-eac000474e7c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00",
"code": "sample string 7"
},
"job_priority_id": "19a0561d-989b-4964-832d-89ceca02ab7c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "60165184-474f-4c7b-997b-1c5925d03690",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cdb79ad2-5bfb-4b56-bd10-a05f81dcd2f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"job_status_id": "3f445f6e-8bc8-47da-b593-66ff1bedb69d",
"job_status_code": "sample string 11",
"db_address_id": "d1a3a2c7-8f77-4b37-95ba-d0a5fb10a0df",
"contact_id": "0fc993b2-a222-4201-b4da-77c2a3dc236b",
"requested_by_company_id": "3c15f7f2-16c2-48f6-8bd3-e39035891b38",
"requested_by_contact_id": "cb33786d-dfa0-4c43-b844-b711947707a6",
"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-08-06T19:59:45.4378259+00:00",
"due_date": "2026-08-06T19:59:45.4378259+00:00",
"date_create": "2026-08-06T19:59:45.4378259+00:00",
"date_update": "2026-08-06T19:59:45.4378259+00:00",
"date_closed": "2026-08-06T19:59:45.4378259+00:00",
"suggested_user_id": "5a665ca7-ce5b-49ba-9bc6-cfb3bf86ad1f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f71bcfea-7334-43a3-96be-8fcaf410d356",
"db_language_id": "fd3d3738-0329-4256-a072-0b807be2bf7b",
"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-08-06T19:59:45.4378259+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c8b0f74f-ce63-4207-9a86-346e3efb11d9",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "82d10e18-62b8-4d94-a3e1-a42c6a05067b",
"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": "fe22cde7-2e50-4a4b-9566-707e039783ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7b2e23e7-1e17-4827-a894-634cac267d30"
},
"suggested_date_start": "2026-08-06T19:59:45.4378259+00:00",
"skill_id": "6e5a069f-538e-45ca-9a77-c128a29dc4e5",
"skill_code": "sample string 32",
"skill": {
"id": "d5a4f404-a25c-4199-a583-a0a41bc4030b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7b9816d0-5770-483a-8484-720320653f48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "061d89b0-d259-460d-924d-913d7fbf711e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3707861-9d60-4213-96d0-624bf2b2298e",
"db_currency_id": "b700aec4-273d-45e0-8e73-7d2949e1b4b1",
"db_language_id": "d5686b5a-7df5-43a0-9f88-7e68ea486d2c",
"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-08-06T19:59:45.4378259+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "af2b8562-1315-490a-9fc3-d54dad3f536a",
"date_reported_by_company": "2026-08-06T19:59:45.4378259+00:00",
"id2": 36,
"company_id": "74f32f56-bb69-4fa0-9ebc-903757f48dc4",
"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": "83ab9f3f-152b-4358-8f98-a32b6894b1a9",
"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-08-06T19:59:45.4378259+00:00"
},
"work_instruction_details_id": "ae522bd2-c734-4808-b4d6-bbb87d34621b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c6deba7b-0ecb-4d28-b974-a5cb5977bb4d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4e032b2e-b3a9-4ec1-84cb-f5b382e4e39d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T19:59:45.4378259+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": "755b454e-dfb6-4a33-a547-d0c5a88e80d8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T19:59:45.4378259+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.