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": "fccb13e9-3031-4e29-9c96-80629afabe9c",
"jobs_id": "f6d1544f-9e95-441d-98a6-f26d754a30eb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "04f73c68-f8e3-471a-bbdf-bb526662bf6f",
"_parent_id": "3f932dc6-b080-42e1-a2fa-f58af96fb2b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0cafbae6-c0b0-4e67-8b4f-ff8d358b4828",
"project_reference_back_office": "sample string 5",
"project": {
"id": "14baadae-ed43-4778-99f5-64998485ee9a",
"_parent_id": "98a04a6a-a0aa-4fd9-a7af-4f5dd4fe251b",
"root_parent_id": "5bcef1e4-560e-48b3-b6b2-ef1bd8659bbd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "49a3fba0-3198-40ce-8850-065f833970e3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b459d23f-1879-4772-b0c5-3add910ac77b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "02e38153-2ac9-4539-aabc-3024d76579ea",
"_parent_code": "sample string 6",
"sales_organization_id": "d0cd9a7a-45a2-438c-91a3-b0085e70c4e4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"equipment_model_id": "5fda357a-e4cd-4889-a738-01e54447161c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "39817847-17b5-432f-a67c-9d136c9db270",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7e767f1a-c3e7-4937-9295-d888fa44d0ca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bba02e68-3657-43dd-8a6e-a89eb1d64c43",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cd83dfe1-c3ca-4f61-954a-9e66bc8c80bd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"equipment_family_id": "d7ec5b53-2a00-459e-b5c2-d9431c57828b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b459d23f-1879-4772-b0c5-3add910ac77b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "02e38153-2ac9-4539-aabc-3024d76579ea",
"_parent_code": "sample string 6",
"sales_organization_id": "d0cd9a7a-45a2-438c-91a3-b0085e70c4e4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"date_in_production_since": "2026-01-26T20:10:35.7458417+00:00",
"date_out_of_production_since": "2026-01-26T20:10:35.7458417+00:00",
"date_end_support": "2026-01-26T20:10:35.7458417+00:00",
"sales_organization_id": "8580b833-c674-4a14-8ad4-16eeaaf55a07",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+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-26T20:10:35.7458417+00:00"
},
"project_status_id": "f06ee7f9-ed5e-43d5-8e1e-57ef0181d8af",
"project_status_code": "sample string 10",
"project_status": {
"id": "66591599-0c2c-4ca7-9bc9-3edd89e78950",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b9b94bdf-db17-438a-a812-e38bb6d2292a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"company_id": "367e4b6a-5a98-4b3a-881d-6f320d735098",
"company_code": "sample string 12",
"db_address_id": "969082bc-a87b-4ad2-a6c1-d2166be559d3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d8683474-ae47-474b-9c22-eb40253c7ecc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f7932286-89ac-4eac-a774-c49cb1ae16fe",
"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-26T20:10:35.7458417+00:00",
"date_create": "2026-01-26T20:10:35.7458417+00:00",
"date_update": "2026-01-26T20:10:35.7458417+00:00",
"updated_by_user_id": "7ea2a781-99c0-4b1e-941e-1a59d427d3fd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-26T20:10:35.7458417+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-26T20:10:35.7458417+00:00",
"date_last_job": "2026-01-26T20:10:35.7458417+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-26T20:10:35.7458417+00:00",
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00",
"is_mobile_installation": true
},
"job_type_id": "9468c5f0-9720-48d3-a21c-6a36d2ef5be7",
"job_type_code": "sample string 7",
"job_type": {
"id": "1ff79b36-5417-4828-8fce-27d8a566aec6",
"name": "sample string 2",
"sales_organization_id": "2eabc206-b4df-4b53-b11e-ca09d4baeefd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00",
"code": "sample string 7"
},
"job_priority_id": "a33cb368-f984-4091-90ce-dae289ed0ae1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ec56236c-a89a-4eb5-9caf-1d3595156060",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "914be621-b9e8-46fc-a440-66622d56e25d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"job_status_id": "4b3d45a6-e220-4f57-ad61-6e04481280aa",
"job_status_code": "sample string 11",
"db_address_id": "d7d61725-bc56-4152-a1a3-df10d6fa1b4f",
"contact_id": "3c248862-ac06-4915-bef4-a0983d3c2664",
"requested_by_company_id": "0bafde11-200f-40d4-8b77-e9399310e979",
"requested_by_contact_id": "91ef19a4-5aed-4a22-bc8f-a105e463c8c7",
"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-26T20:10:35.7458417+00:00",
"due_date": "2026-01-26T20:10:35.7458417+00:00",
"date_create": "2026-01-26T20:10:35.7458417+00:00",
"date_update": "2026-01-26T20:10:35.7458417+00:00",
"date_closed": "2026-01-26T20:10:35.7458417+00:00",
"suggested_user_id": "78b9bf41-6229-4f04-b922-d7b68ff6978f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4a5ed773-7e4e-4159-a264-996fa5bf8616",
"db_language_id": "5b7df9fb-caea-4fe9-967e-f42377dbf4fa",
"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-26T20:10:35.7458417+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c18cd36c-b3d1-4147-b331-56ab3d6067cd",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fbfc84b9-c44a-49f3-ab56-51ec307577d0",
"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": "1266cb9e-266a-497b-8357-5017ad5d4cde",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50e68940-b89f-4b9e-9811-437ae9f6fc55"
},
"suggested_date_start": "2026-01-26T20:10:35.7458417+00:00",
"skill_id": "30aba752-979f-4035-92f0-be8dc292965b",
"skill_code": "sample string 32",
"skill": {
"id": "3178c70f-5866-46ff-acea-69431842928b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "35859688-d789-438a-a1ef-6db6771e99e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1247c5c5-58c0-40f0-9b9f-a3c5b30349a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24829d17-b3c0-49ab-b245-2b2002adb261",
"db_currency_id": "e22f6c04-18d9-4f9c-8fc9-4e685d4cdeb7",
"db_language_id": "089a102f-2853-474b-89d7-e85c1fedc2a6",
"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-26T20:10:35.7458417+00:00"
},
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f551c3b-c8dc-4a09-b362-e219bae0e34a",
"date_reported_by_company": "2026-01-26T20:10:35.7458417+00:00",
"id2": 36,
"company_id": "c2b86ade-3d8c-4aa6-89bc-78c862335a5a",
"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": "07d69f9a-5e10-48bd-bf28-5f76c6e9fb06",
"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-26T20:10:35.7458417+00:00"
},
"work_instruction_details_id": "e362fd35-c0f1-43f7-aed3-ec909559bf36",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dda1ecaa-0a4e-41cb-91af-be783a957dd6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "012a24f9-3ca3-4213-abfc-ac4abda8d559",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-26T20:10:35.7458417+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": "d6787f06-5d2f-459b-945b-970b88e0d3f3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-26T20:10:35.7458417+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.