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": "2a47ae7a-2b59-4f71-80d3-ff0f9fbeaba3",
"jobs_id": "cecf1d2d-e67f-4b02-a67f-54d0c4f2563a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9a632214-1fd2-40bd-9fa8-4a89d8fd73ef",
"_parent_id": "16b21fef-ed6c-465f-ab55-61d33958df01",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dfb30814-7d22-4830-94c3-e054ce44ec21",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dee8d845-6644-4025-9d3e-30ca40eab7a7",
"_parent_id": "ffb46b5a-93fe-40c2-b817-dc817367a87f",
"root_parent_id": "04001586-9519-47f0-962c-c8d18e98497b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1f83ea26-a20f-4cba-a4bd-7cfca9a6b4b9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "db2c637a-929f-44a6-939c-e1c86382abda",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ecd8fd1-2035-4600-bd5e-b15ea4814b2d",
"_parent_code": "sample string 6",
"sales_organization_id": "ced81d9c-0309-4425-95c1-f16f00a427cf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"equipment_model_id": "9150bdd1-32c1-4a25-9226-a02fd77399a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fa1d6eca-83a3-49b8-b3a4-6425e5c59e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "66958c89-cbf9-433c-b132-8e1b80630e3b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c91af0e0-0ed2-41e0-9561-bab30b5aefa2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "35ec4629-37fc-4eb4-a5c7-490e24ec98aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"equipment_family_id": "5b817b36-3300-4e9d-a4f8-013f73e223ab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "db2c637a-929f-44a6-939c-e1c86382abda",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ecd8fd1-2035-4600-bd5e-b15ea4814b2d",
"_parent_code": "sample string 6",
"sales_organization_id": "ced81d9c-0309-4425-95c1-f16f00a427cf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"date_in_production_since": "2026-03-12T10:14:24.4178061+00:00",
"date_out_of_production_since": "2026-03-12T10:14:24.4178061+00:00",
"date_end_support": "2026-03-12T10:14:24.4178061+00:00",
"sales_organization_id": "a0872bc2-be5c-4a24-8e5b-89b2e0ef3904",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+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-03-12T10:14:24.4178061+00:00"
},
"project_status_id": "540a45e2-29e7-472a-92a6-16df79e83c1e",
"project_status_code": "sample string 10",
"project_status": {
"id": "9bb6d43d-09e5-401b-8cac-b2404117cf4e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "40a07bd1-0422-4891-9752-38e9886a9421",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"company_id": "799adb9f-9abe-47ab-bad9-c6563dfbad21",
"company_code": "sample string 12",
"db_address_id": "94525dfb-1489-4da7-9818-5c389703e2b9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb87dd4a-b69e-4e89-b15f-8028b3e032b3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b83c617b-a3d8-4c8b-8b4b-9755f5acb4a0",
"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-03-12T10:14:24.4178061+00:00",
"date_create": "2026-03-12T10:14:24.4178061+00:00",
"date_update": "2026-03-12T10:14:24.4178061+00:00",
"updated_by_user_id": "6fdd9e93-48d6-4943-8e3e-e75d2f4d2975",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T10:14:24.4178061+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T10:14:24.4178061+00:00",
"date_last_job": "2026-03-12T10:14:24.4178061+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T10:14:24.4178061+00:00",
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00",
"is_mobile_installation": true
},
"job_type_id": "9e61cd7b-2683-415c-809a-571b923831f4",
"job_type_code": "sample string 7",
"job_type": {
"id": "4ac0e45a-938c-47b2-acf1-ba6d011236ef",
"name": "sample string 2",
"sales_organization_id": "a2677898-0af7-4dc0-9a96-6079950665e7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00",
"code": "sample string 7"
},
"job_priority_id": "6e77ee65-7f90-4d16-b730-d173b4b8e440",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e796996e-27f2-459b-ba16-b0910a7f2731",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a6cf54c1-ded9-49b3-a18c-c2ce81bb0dc6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"job_status_id": "d4701f79-6b66-4745-8045-0c57eef3d4fb",
"job_status_code": "sample string 11",
"db_address_id": "a95144b3-8de3-4262-8e37-c339441ca28a",
"contact_id": "defee5fa-3efa-4d43-8b02-697fb661e9e3",
"requested_by_company_id": "3901c589-b837-4609-ad12-8882332538fa",
"requested_by_contact_id": "73589455-a4ec-4a8a-a572-caa9403b1e88",
"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-03-12T10:14:24.4178061+00:00",
"due_date": "2026-03-12T10:14:24.4178061+00:00",
"date_create": "2026-03-12T10:14:24.4178061+00:00",
"date_update": "2026-03-12T10:14:24.4178061+00:00",
"date_closed": "2026-03-12T10:14:24.4178061+00:00",
"suggested_user_id": "ed642078-05dc-495e-a5d4-a14c4968c795",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64886fbd-c577-4c97-abe6-9de82f7f74a4",
"db_language_id": "1979dafd-24c4-49ad-8db7-09e1ec4dbd23",
"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-03-12T10:14:24.4178061+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "718d873d-6b2d-4d4d-8be3-b0f3b1c94d00",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e211f4b2-c5b1-4c3a-a5e9-d3275d13a635",
"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": "567c53ad-95ef-483e-83e5-6e23e7e1529e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ad3d9f1e-30ab-4f3e-9948-864eb23a2680"
},
"suggested_date_start": "2026-03-12T10:14:24.4178061+00:00",
"skill_id": "e569e06b-cef8-40eb-9685-7c312771488e",
"skill_code": "sample string 32",
"skill": {
"id": "fd4baec0-920f-49d3-8c02-26fa85febcdd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0a435ad4-0ebd-4c72-acd4-e385807ee4b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "878074aa-9546-486e-bd5d-14143e463eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba0cf63-868b-4b8a-997b-7dfeee3c5a00",
"db_currency_id": "acbf6ae2-5d81-4e02-ac96-ed008fd477c9",
"db_language_id": "1dd75319-6975-4926-80ad-0efa19e34d93",
"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-03-12T10:14:24.4178061+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9fe655e5-ca82-407d-83c9-54639189c0ee",
"date_reported_by_company": "2026-03-12T10:14:24.4178061+00:00",
"id2": 36,
"company_id": "b736d65d-169b-487c-8741-66f887b918cf",
"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": "7ef578f7-8695-4b94-a12c-4d89c78ebe0e",
"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-03-12T10:14:24.4178061+00:00"
},
"work_instruction_details_id": "2f5e3c39-6be7-49f5-93ca-1d6bb2e71f08",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95160582-b116-4487-9c4a-3772329cc06f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f2c0ff66-77ca-41e5-875f-cf5ccced4b69",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T10:14:24.4178061+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": "e606548f-fe11-4a7e-9be9-dd9b7a9e9e30",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T10:14:24.4178061+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.