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": "2a399328-a1f2-450a-8cb0-af41c966f60f",
"jobs_id": "a06a0d12-296c-48ad-93e5-cd05e3d0d5f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "86ed7706-1add-460f-b15e-06fb6b256c4f",
"_parent_id": "f98b01d1-cdd8-4536-9926-5e4532e2aa6a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6e01a502-56e0-4604-9c0c-2e7eadd29642",
"project_reference_back_office": "sample string 5",
"project": {
"id": "66a6ed62-9fe9-49e9-ad06-cfde8e7f18b1",
"_parent_id": "b2433b49-f922-480e-a052-a80ea00f8f87",
"root_parent_id": "895fdfa3-138c-4b65-b000-7fbec5f0677f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bcccfa1d-48cc-4b69-9c21-6f12ed8bc92c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0bd67375-be19-414c-9f66-0ae9a34a5e79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd40beea-3e71-4b40-b56a-50c660f26a3e",
"_parent_code": "sample string 6",
"sales_organization_id": "d04f1a5d-db50-433b-b5f9-2c50aba21c27",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"equipment_model_id": "29f00964-3c99-4aa0-8431-bb50264926a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "533c87bc-4a36-4415-b563-9482883b167e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d806de9d-e10a-4dfb-a995-dce88097e9ed",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b95bc7ca-f4eb-4797-9953-fd79c450ae72",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "40ba995f-b512-4220-8b30-3d95146aed4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"equipment_family_id": "86ca15ae-0da2-457c-a030-a7469aafb531",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0bd67375-be19-414c-9f66-0ae9a34a5e79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd40beea-3e71-4b40-b56a-50c660f26a3e",
"_parent_code": "sample string 6",
"sales_organization_id": "d04f1a5d-db50-433b-b5f9-2c50aba21c27",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"date_in_production_since": "2026-08-02T04:57:02.2404499+00:00",
"date_out_of_production_since": "2026-08-02T04:57:02.2404499+00:00",
"date_end_support": "2026-08-02T04:57:02.2404499+00:00",
"sales_organization_id": "f5b2ffca-c899-4def-8817-dfbf3a1778e7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+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-02T04:57:02.2404499+00:00"
},
"project_status_id": "b6692b1a-2fc6-4a53-afdd-a358cceb6e1a",
"project_status_code": "sample string 10",
"project_status": {
"id": "f0933c2b-443f-4966-8404-3c1a65a68d7b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b5e8952d-9f31-461a-863f-007f44f155d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"company_id": "591aaba0-c684-47b1-a94b-ad1c225c78bb",
"company_code": "sample string 12",
"db_address_id": "b2f3b0b4-36a4-4736-a0eb-a528473a0da6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3c95d66a-0596-4008-bfdc-702aef0f2c73",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "96bccd5a-2d7e-4620-af77-3a4a744e74c0",
"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-02T04:57:02.2404499+00:00",
"date_create": "2026-08-02T04:57:02.2404499+00:00",
"date_update": "2026-08-02T04:57:02.2404499+00:00",
"updated_by_user_id": "ec3e4f54-7a3b-4722-9386-72e5f31bad4a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-02T04:57:02.2404499+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-02T04:57:02.2404499+00:00",
"date_last_job": "2026-08-02T04:57:02.2404499+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-02T04:57:02.2404499+00:00",
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00",
"is_mobile_installation": true
},
"job_type_id": "c09af44d-538f-4780-b8cf-8aa65c5a6e7c",
"job_type_code": "sample string 7",
"job_type": {
"id": "12ea35ff-a8e5-4e17-af36-48b75a20454e",
"name": "sample string 2",
"sales_organization_id": "d2f4d110-376e-4402-acca-bc02070f8ccd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc49faa7-6ed4-4a2e-8fde-1d350cd82ed3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7f346eb4-36cc-4315-9722-a15ff49f6e88",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f85cf434-226d-4a13-9ec6-fcafde17e427",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"job_status_id": "141ca9ba-bac4-4d71-8c80-382b8c85b8e3",
"job_status_code": "sample string 11",
"db_address_id": "11cae95b-a1ab-477c-aa02-c81c5bfe8d1f",
"contact_id": "f9080591-9445-4e3e-be34-572e3756d72e",
"requested_by_company_id": "ea524d16-7913-4b08-ae7f-5ed764a67b53",
"requested_by_contact_id": "f1655dae-cbaf-4bdd-94fb-0b2598543e50",
"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-02T04:57:02.2404499+00:00",
"due_date": "2026-08-02T04:57:02.2404499+00:00",
"date_create": "2026-08-02T04:57:02.2404499+00:00",
"date_update": "2026-08-02T04:57:02.2404499+00:00",
"date_closed": "2026-08-02T04:57:02.2404499+00:00",
"suggested_user_id": "5e7029cc-1dfb-4049-b08e-c012172b159d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "df75b4c8-6523-4eb3-b3b4-66c79a57795c",
"db_language_id": "3fba4f77-86cd-4ba0-b6ec-3855aa92f31d",
"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-02T04:57:02.2404499+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "81d1b039-997c-475d-852d-0f87298e83e5",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77929ab7-280b-403c-8e39-5571e34bdbe8",
"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": "2221faf7-a0dd-42d5-994f-72c5762959b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c7996f7e-a2d5-44e3-ab59-62a25b7e165f"
},
"suggested_date_start": "2026-08-02T04:57:02.2404499+00:00",
"skill_id": "d306951d-9f77-485e-a48e-30ab03bec8c1",
"skill_code": "sample string 32",
"skill": {
"id": "07145a6c-f496-4a90-9e8b-a14a445a80a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f18ecb9-4f05-4497-bee9-d1546278f7f5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf6b34d8-3537-4f01-8f71-e8df13ea4fde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c2d6a30-44d9-471c-8256-af49480d990c",
"db_currency_id": "d1160006-e047-42d0-9696-e0fba7613939",
"db_language_id": "5a44eee1-b09e-4f41-b3af-be903f21625e",
"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-02T04:57:02.2404499+00:00"
},
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3dfcfd17-13e1-4904-a93d-f7a43fef8aa8",
"date_reported_by_company": "2026-08-02T04:57:02.2404499+00:00",
"id2": 36,
"company_id": "0c94db5d-5ae3-4fdf-b867-88eaaad95a7a",
"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": "267eb6c7-f2e5-4c9a-912a-7261e8ddc73d",
"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-02T04:57:02.2404499+00:00"
},
"work_instruction_details_id": "d068a09c-25a1-4c77-896a-f4e466994e9d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ec0d0fed-8218-43f2-9387-a947db0ecec6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b0fbcd4f-37b3-43d6-ba33-e8931f40a697",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-02T04:57:02.2404499+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": "e11d5c87-819b-4d79-8757-22fa5b1f69b0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-02T04:57:02.2404499+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.