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": "5b33d8fc-c3b4-4008-860d-5c20a6514ac6",
"jobs_id": "ce367523-c7c5-44b6-8d7b-5e65fdf881fd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f5efbeb6-7d68-4b6c-ab93-05d5e28a4112",
"_parent_id": "0a9478f1-cece-474b-99fa-f102fd0e7e31",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "16af1070-848a-4835-ae0d-7c6b8eab11e9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0fe5c8bc-3ea0-4bd7-babf-5ff9f3df12a7",
"_parent_id": "cb0532e2-e424-487c-b6b1-38ce16988baf",
"root_parent_id": "260feba1-ce7f-427d-928f-4df08a59e9e0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "224702bd-4a91-439e-8f91-504051b28a8e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d6901bbd-c3a5-41e5-b830-c193a105a264",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e02f3007-f0e5-4385-8e1c-18339993593a",
"_parent_code": "sample string 6",
"sales_organization_id": "b2138fc6-14bd-4a0f-b6c6-57a2f0588784",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"equipment_model_id": "d73678c5-ea80-478d-a7ee-fe7f0388627c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68caa4ba-ef1f-40e2-8d09-09e1e5b1efef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "575eafc1-cd82-4c44-81e5-be2c8e959767",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "573133f7-9e74-4dcb-a491-3fb14b6dc172",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dc2bcc7a-e92c-44d8-9a74-5b6c90936ff9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"equipment_family_id": "250ece27-93d6-4cd4-b26d-794bfaa70f6d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d6901bbd-c3a5-41e5-b830-c193a105a264",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e02f3007-f0e5-4385-8e1c-18339993593a",
"_parent_code": "sample string 6",
"sales_organization_id": "b2138fc6-14bd-4a0f-b6c6-57a2f0588784",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"date_in_production_since": "2026-05-21T10:18:43.662398+00:00",
"date_out_of_production_since": "2026-05-21T10:18:43.662398+00:00",
"date_end_support": "2026-05-21T10:18:43.662398+00:00",
"sales_organization_id": "ad6e11a5-d713-498c-ab28-19bf88522676",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+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-21T10:18:43.662398+00:00"
},
"project_status_id": "23d9493a-79d0-4180-b90e-5c2337d501e2",
"project_status_code": "sample string 10",
"project_status": {
"id": "9f4fb40e-6a20-41fb-b620-5bcba453989c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2ffb5a5f-336b-43ba-8688-df844525758a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"company_id": "3411c0d5-bd0a-49c0-91b7-701c3cda0b0c",
"company_code": "sample string 12",
"db_address_id": "309264a6-0f13-4da7-bd80-a711aaaa43de",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aa523331-2a3f-4690-8900-fb3573a86416",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3915f028-3102-4c22-993a-b1278349e459",
"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-21T10:18:43.662398+00:00",
"date_create": "2026-05-21T10:18:43.662398+00:00",
"date_update": "2026-05-21T10:18:43.662398+00:00",
"updated_by_user_id": "5fa81be9-97fe-485d-a482-469ef3fb38c3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T10:18:43.662398+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T10:18:43.662398+00:00",
"date_last_job": "2026-05-21T10:18:43.662398+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T10:18:43.662398+00:00",
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00",
"is_mobile_installation": true
},
"job_type_id": "97a12dd7-83a5-4dad-8248-f00877c18843",
"job_type_code": "sample string 7",
"job_type": {
"id": "a426177d-d81e-4865-b525-264e3f60609e",
"name": "sample string 2",
"sales_organization_id": "e7d46231-0b57-44c6-9c15-d7a633eef7dd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00",
"code": "sample string 7"
},
"job_priority_id": "dd08fb18-7885-4898-b9f2-e90207ebcac0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "be394006-dce9-46c9-abc0-df475e475e5e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "52604f98-7f38-4615-91d0-c0e034076d61",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"job_status_id": "235b63a8-5cee-4bd9-b551-aed4b21ee866",
"job_status_code": "sample string 11",
"db_address_id": "24c88252-d0b6-41a0-8e48-82325e1d47cb",
"contact_id": "62f99890-98de-47e6-8d56-7e5b083454b7",
"requested_by_company_id": "e8020ebf-2b83-4ce8-877a-eec8adf9bd99",
"requested_by_contact_id": "c3b2cc03-5504-446e-ab89-51896596cc68",
"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-21T10:18:43.662398+00:00",
"due_date": "2026-05-21T10:18:43.662398+00:00",
"date_create": "2026-05-21T10:18:43.662398+00:00",
"date_update": "2026-05-21T10:18:43.662398+00:00",
"date_closed": "2026-05-21T10:18:43.662398+00:00",
"suggested_user_id": "cf487999-6543-40a8-9aa5-91e4c5458def",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a4e01983-4fe6-4bd5-8ad5-abd13d70ff49",
"db_language_id": "4c5e8fed-95cd-44a6-a13d-514e98a04d28",
"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-21T10:18:43.662398+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d1ee2b6e-6e98-4a0f-900b-971e108ff1d6",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "947c48dc-b817-4361-bdc9-f4145616e73c",
"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": "0382de76-2916-4d98-bf10-e0d791a9695c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "78f941dd-0d54-41f9-98bc-4d45c179e8fe"
},
"suggested_date_start": "2026-05-21T10:18:43.662398+00:00",
"skill_id": "24d91aaa-ac40-4ac1-8550-816cfbec265d",
"skill_code": "sample string 32",
"skill": {
"id": "d17b822e-b5ff-4b16-9976-00819c3bb5bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4212eb90-aebe-498f-9a14-91650d7c818b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34d4c291-c4dd-4a8a-8187-118944df8131",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84995669-9521-422f-8e44-4967826864d2",
"db_currency_id": "2fc99965-4fb0-4ac1-8e65-db7cd876425f",
"db_language_id": "07c55429-8dbe-4796-9544-2c15a49fb6ec",
"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-21T10:18:43.662398+00:00"
},
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d6a11dcd-afed-4888-83f0-1573bed73810",
"date_reported_by_company": "2026-05-21T10:18:43.662398+00:00",
"id2": 36,
"company_id": "8ff6dd97-2c80-4f0f-8630-1644d754f0ae",
"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": "ee779a00-f664-4d63-8d75-f4312dbd2e68",
"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-21T10:18:43.662398+00:00"
},
"work_instruction_details_id": "577f5d09-c444-4168-b0ed-9e48ba5f0d37",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7281b975-1c5e-44d1-bf10-ac26f2a7e4e7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "118f6944-bdb1-468d-bb0f-3d7f6afb9e65",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T10:18:43.662398+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": "c2f7691b-f484-47cd-95a5-ed2a641b5fdd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T10:18:43.662398+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.