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": "02b4177e-f5b0-4c5e-b409-0889957fceda",
"jobs_id": "38fdb37d-76dd-44a0-825f-9c9929773cd9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9d07a3ce-71d9-42a4-a3dc-280a534dbc42",
"_parent_id": "f6ee3382-c509-4ee2-9ddd-e3e77a5593bd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ba70edf-5519-4641-a666-20d275c1732d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2ef8f86a-10ef-4bb9-a34a-4f04389be590",
"_parent_id": "ff3c7a4e-175f-44a6-beff-2b61f32afaf0",
"root_parent_id": "4f9b42ec-8088-4263-84e1-8d0f4475f629",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c4db18d4-fec9-4e7a-9ffd-dfefaf9fb9fb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6d7843c9-a561-47d8-b45b-a28a7309177c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "058c4b55-3342-409f-987b-ee16882ce865",
"_parent_code": "sample string 6",
"sales_organization_id": "dff5d29e-3f19-44b0-8883-f8f4a76e6172",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"modified_dateutc": "2026-02-18T08:36:15.4178814+00:00"
},
"equipment_model_id": "587ad24d-f474-43f8-bae5-a184b45a54a1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0bb3babe-a910-4fda-bba0-9840f9376924",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7cc968ad-340e-42cc-a412-08e2718254a8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1dbc53b4-1f75-4b03-af05-a17395f1eb9f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ac3d4c46-08cb-42c9-89b4-76e5ffa6f6bf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"modified_dateutc": "2026-02-18T08:36:15.4178814+00:00"
},
"equipment_family_id": "e65d9449-850a-485c-922e-839036fc67a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6d7843c9-a561-47d8-b45b-a28a7309177c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "058c4b55-3342-409f-987b-ee16882ce865",
"_parent_code": "sample string 6",
"sales_organization_id": "dff5d29e-3f19-44b0-8883-f8f4a76e6172",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"modified_dateutc": "2026-02-18T08:36:15.4178814+00:00"
},
"date_in_production_since": "2026-02-18T08:36:15.4335052+00:00",
"date_out_of_production_since": "2026-02-18T08:36:15.4335052+00:00",
"date_end_support": "2026-02-18T08:36:15.4335052+00:00",
"sales_organization_id": "8a118d5b-8c6c-4721-8d4b-ca1868d7ab08",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+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-02-18T08:36:15.4335052+00:00"
},
"project_status_id": "8743c51b-309f-4c06-9845-ec0ce650d5ae",
"project_status_code": "sample string 10",
"project_status": {
"id": "7477be59-1125-4e13-90f9-d6a88fd290f3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9762d011-41cc-45f0-bf6d-e8223e4d9b69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00"
},
"company_id": "ccf4da51-7c7f-472e-8f37-c16297123094",
"company_code": "sample string 12",
"db_address_id": "b5b330f3-9e3f-43d6-9047-0e650c0988cc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d2dca81e-a0bd-46ac-9eb9-cb16c6933548",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "23e52c95-baec-41fb-bd3a-0f42a3f09998",
"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-02-18T08:36:15.4335052+00:00",
"date_create": "2026-02-18T08:36:15.4335052+00:00",
"date_update": "2026-02-18T08:36:15.4335052+00:00",
"updated_by_user_id": "1b56823e-4587-4c2e-b7a3-2df05f445348",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T08:36:15.4335052+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T08:36:15.4335052+00:00",
"date_last_job": "2026-02-18T08:36:15.4335052+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T08:36:15.4335052+00:00",
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c141ec3-c6e5-4859-8d7f-112bae46f9a6",
"job_type_code": "sample string 7",
"job_type": {
"id": "448db83f-7557-4c45-aa10-ddffe794a756",
"name": "sample string 2",
"sales_organization_id": "112c7cab-99c9-4ce9-b201-fd33c619cfa3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00",
"code": "sample string 7"
},
"job_priority_id": "87cc8ada-4a8b-463d-810d-2fa36c937d15",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cc3cc80c-4acd-41c6-9753-cffcc5eb134f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c154ef99-d94e-4479-861f-1b5a95bc1435",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00"
},
"job_status_id": "ea897c8c-1100-4c3f-aad8-497c581c0204",
"job_status_code": "sample string 11",
"db_address_id": "47fe5b95-29e0-4e92-8037-4135719dc6e1",
"contact_id": "0b6352b3-93c9-436a-9ad0-b3971ad37e80",
"requested_by_company_id": "807771cb-24cc-4cb8-bd48-a8291505cba5",
"requested_by_contact_id": "2bc65457-f86b-4da8-9687-df3ca59230f3",
"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-02-18T08:36:15.4335052+00:00",
"due_date": "2026-02-18T08:36:15.4335052+00:00",
"date_create": "2026-02-18T08:36:15.4335052+00:00",
"date_update": "2026-02-18T08:36:15.4335052+00:00",
"date_closed": "2026-02-18T08:36:15.4335052+00:00",
"suggested_user_id": "8cb019ff-46f0-4c7d-a8e1-1c2ad7585c47",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2da7cd45-a5b5-489f-9bb5-d2a90e7c7808",
"db_language_id": "cbfee2a7-00af-4464-a1e9-55b717801ce4",
"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-02-18T08:36:15.4335052+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "122ff01e-8dd1-4d61-aaf4-0cad89c91e0b",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c9485e27-2579-44b3-b45d-b401642fe724",
"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": "18f947b9-be26-411d-b5af-eb0d85f58264",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "958c5272-91c8-4fbb-a8a5-ffb95c5bc81a"
},
"suggested_date_start": "2026-02-18T08:36:15.4335052+00:00",
"skill_id": "f1d3ee5e-0e97-4b16-ae15-f5668f5be9de",
"skill_code": "sample string 32",
"skill": {
"id": "9d70c902-95c3-4e83-b263-5a5a1b3a08bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "309cd409-e123-4cbc-8169-1ce2e8ff7e15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9df5607a-6e30-4fc6-9ec8-622cf18bdae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab0575a6-0382-4b6e-a503-6a7ac7c8dd30",
"db_currency_id": "9b9829a4-4d48-4e06-8838-4e48e2ef15cd",
"db_language_id": "288cd067-9a5e-4c86-b5c4-344f8c5d866f",
"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-02-18T08:36:15.4178814+00:00"
},
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c51390dc-352a-4fcf-b274-4cd5be0217bb",
"date_reported_by_company": "2026-02-18T08:36:15.4335052+00:00",
"id2": 36,
"company_id": "5abd71e0-cdb6-4eaf-992f-de4406a7d1e3",
"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": "13a32bad-abe6-415b-91c8-900a57a71a43",
"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-02-18T08:36:15.4335052+00:00"
},
"work_instruction_details_id": "b576b059-f3a5-477b-9237-28aeb89a4efb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5eb5e28a-e423-41f7-bf12-bb0d008d74a5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a56bbec4-2271-4132-be0f-82e856df9a15",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T08:36:15.4335052+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": "7662671c-1018-4fbb-ba97-c601edda1b70",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T08:36:15.4335052+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.