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": "d5361d3f-2ad3-41bb-b395-a3091b588fd2",
"jobs_id": "819243d1-6c1b-41c2-88a3-4e897bcd2b37",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a665eec9-e57e-4783-b3eb-7bdd3deff35b",
"_parent_id": "0dbd02d6-a5f3-433f-9a32-1a26ee8e44f6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bf044695-bac8-4947-9dbf-e21ed76a9bc3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "660a164f-80ee-4874-9a60-aa213e95719e",
"_parent_id": "b781cf0f-6166-4cd5-b0fa-64c391b6b692",
"root_parent_id": "574987fb-e1d9-4b57-b47a-9ce1b2af267b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bed90ac1-a866-48ad-a713-51c225c9d681",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e1c1c67b-3ef5-44d2-9989-9158fae42763",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "438119cd-411e-4e60-8312-19098181657e",
"_parent_code": "sample string 6",
"sales_organization_id": "855ea88e-ea7c-42d8-bd05-604ff9950339",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"modified_dateutc": "2026-04-05T03:14:04.1070565+00:00"
},
"equipment_model_id": "a55124ec-572b-458c-9131-d8d560380757",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9dad5929-5b1b-4a8c-97dc-750c56acc799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6bd68185-69df-4e37-9cdc-7970bad8c6d6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e9ba6f3d-9220-446d-80a2-69894b4b8c18",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0018671e-2fcc-4444-a7c8-88485da5637c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"modified_dateutc": "2026-04-05T03:14:04.1070565+00:00"
},
"equipment_family_id": "281ac732-f24e-4386-811d-1c8000fc0729",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e1c1c67b-3ef5-44d2-9989-9158fae42763",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "438119cd-411e-4e60-8312-19098181657e",
"_parent_code": "sample string 6",
"sales_organization_id": "855ea88e-ea7c-42d8-bd05-604ff9950339",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"modified_dateutc": "2026-04-05T03:14:04.1070565+00:00"
},
"date_in_production_since": "2026-04-05T03:14:04.1070565+00:00",
"date_out_of_production_since": "2026-04-05T03:14:04.1070565+00:00",
"date_end_support": "2026-04-05T03:14:04.1070565+00:00",
"sales_organization_id": "bbf5ca28-b90b-4a30-b3eb-c9fd96d50942",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+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-04-05T03:14:04.1070565+00:00"
},
"project_status_id": "b948e38d-9d31-4845-9878-0040aa0527a8",
"project_status_code": "sample string 10",
"project_status": {
"id": "f4837cc7-bb02-45d0-984e-5e369f677e1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "70b3b25c-7675-4f46-b5db-b21bf994ae4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-05T03:14:04.1070565+00:00"
},
"company_id": "42dd8472-b379-4abb-85d1-6a578bfd78cf",
"company_code": "sample string 12",
"db_address_id": "f9e36bf8-2030-4f78-8b8c-99ec0a9afcd8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "61a1a8a0-ea94-413a-9c80-f695d85a186e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7523e1e3-e6ac-4108-aa65-17475a3e282a",
"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-04-05T03:14:04.1070565+00:00",
"date_create": "2026-04-05T03:14:04.1070565+00:00",
"date_update": "2026-04-05T03:14:04.1070565+00:00",
"updated_by_user_id": "91b6d25f-4cc8-4f96-9fee-d7b181d0d97e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-05T03:14:04.1070565+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-04-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-05T03:14:04.1226829+00:00",
"date_last_job": "2026-04-05T03:14:04.1226829+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-05T03:14:04.1226829+00:00",
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00",
"is_mobile_installation": true
},
"job_type_id": "40ca0ba5-b013-4495-bfee-d7f01f78d9b3",
"job_type_code": "sample string 7",
"job_type": {
"id": "aef6e413-2093-49cf-ac29-16eb0dc66f59",
"name": "sample string 2",
"sales_organization_id": "3f5b61d8-36b0-4700-87c9-0ad0c28b3015",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00",
"code": "sample string 7"
},
"job_priority_id": "22f1d678-1f4b-4e4c-9978-ebdef17d27a4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b66a6d8c-c0e6-4112-8cb0-60db621c8a70",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b66cd46a-b76e-46f0-aac9-d5c04fdf1148",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00"
},
"job_status_id": "4a763acb-982e-49c4-9a7c-365ec69d11a6",
"job_status_code": "sample string 11",
"db_address_id": "0fc6ae45-6f02-4d67-91d9-8fbc741bcb88",
"contact_id": "e45170fb-fb26-40fb-bf38-4bc99205a3c9",
"requested_by_company_id": "b4733b03-a65c-402d-aaca-b4d7760b542f",
"requested_by_contact_id": "51aca39f-1145-4ffd-af87-2ae3e6d30611",
"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-04-05T03:14:04.1226829+00:00",
"due_date": "2026-04-05T03:14:04.1226829+00:00",
"date_create": "2026-04-05T03:14:04.1226829+00:00",
"date_update": "2026-04-05T03:14:04.1226829+00:00",
"date_closed": "2026-04-05T03:14:04.1226829+00:00",
"suggested_user_id": "e27f5c4e-8a6c-45f6-9838-e9c822e9564a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "20115f39-da7d-40b0-84ff-a1bca21932ce",
"db_language_id": "14e2ef4a-42d2-4091-8578-b899e4eb1534",
"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-04-05T03:14:04.1226829+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "44c942e7-9293-46c5-b5b2-fc11a9e14849",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0bccd9a1-92c8-44cc-8bb5-7c2afa053620",
"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": "7e82ba4e-59f0-4553-be83-e24b692296b8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "af037ad1-bc4d-4ae0-ab28-ae0a2d801a19"
},
"suggested_date_start": "2026-04-05T03:14:04.1226829+00:00",
"skill_id": "bd045d4e-7c30-43a7-8f9b-4b29cf01bf39",
"skill_code": "sample string 32",
"skill": {
"id": "f9405931-c4e4-4b24-b83b-ccecd36c3691",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5cb9f808-523d-454c-9ce8-1bd2c22ae144",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63488b5c-d0d2-4bf6-9a0f-b078478e2435",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba2e4b32-a37c-4f62-bd0d-ab4e655e483d",
"db_currency_id": "43a6cde7-6736-4a32-b0f7-7bc633bfe334",
"db_language_id": "221e4c66-dfe6-4899-993b-47cf7d1a8bd4",
"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-04-05T03:14:04.1070565+00:00"
},
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7c7792a1-1e10-43da-b559-f305a23fc9ef",
"date_reported_by_company": "2026-04-05T03:14:04.1226829+00:00",
"id2": 36,
"company_id": "6ad59eae-498d-4cd9-ae6b-8bbffeee2121",
"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": "3e323a73-370c-4028-9a27-7ea11bb9ceee",
"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-04-05T03:14:04.1226829+00:00"
},
"work_instruction_details_id": "29491ff5-8045-448f-ac2f-cfc659999f44",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ea086d92-47b5-45d8-b1ff-5e445ba2768b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea2d2f04-fe9b-4570-bf55-2dc5a170337e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-05T03:14:04.1226829+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": "11763d6c-2f12-4f70-bd3c-2b64ebf7b042",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-05T03:14:04.1226829+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.