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": "1d007214-def8-4a5e-a703-61e95262f1b9",
"jobs_id": "50230371-5176-4570-ac1b-b994359eabf2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a636507a-2a24-4399-96a0-5506d129f410",
"_parent_id": "95b0af65-8212-41f3-8569-5b081ecd516b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ae685b36-90cb-44cd-a443-01a1af41b4d2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dcfc6b60-2e65-49cb-bb65-a75620d249da",
"_parent_id": "834a6e7e-fcc2-4047-8d7b-cf670d58f20d",
"root_parent_id": "981b19e6-59f4-4fe7-9d55-5ca61b020219",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf60e7eb-710c-4392-aa70-b2c573b2d759",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f6f6018e-9b30-4fc5-9d57-d13fd74a7f12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe4a7601-0aca-41c6-90bd-b34238cc0c30",
"_parent_code": "sample string 6",
"sales_organization_id": "b6143b49-afd7-469b-b978-8f85df982a02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"equipment_model_id": "67394ead-75b5-454e-ba8f-7db6f55771da",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3222797b-2991-4729-8e57-aecf425694d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6bc97475-e13e-4672-a23b-a711f962a8ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dafeb392-b944-4885-af82-a1f9b2dad9ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4cdf590a-7e17-487d-b42e-720843558d82",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"equipment_family_id": "75d19ac2-12a7-470f-ba75-f20f44babec9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f6f6018e-9b30-4fc5-9d57-d13fd74a7f12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe4a7601-0aca-41c6-90bd-b34238cc0c30",
"_parent_code": "sample string 6",
"sales_organization_id": "b6143b49-afd7-469b-b978-8f85df982a02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"date_in_production_since": "2026-01-11T06:54:21.0421378+00:00",
"date_out_of_production_since": "2026-01-11T06:54:21.0421378+00:00",
"date_end_support": "2026-01-11T06:54:21.0421378+00:00",
"sales_organization_id": "f958b773-55cf-416f-a7c5-a32fe0bed2b4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+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-11T06:54:21.0421378+00:00"
},
"project_status_id": "dc0d3541-d107-49a1-86ab-bba7dab4654d",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ea18f4d-93f4-496f-9ad2-e7f78df4fcf7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50bd476d-47be-4f37-b725-e2155cc72a8f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"company_id": "1f1d0c41-7da9-4346-9e22-ad2977118d6b",
"company_code": "sample string 12",
"db_address_id": "a728da27-7f88-4a9b-b784-32d86c8f861f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2b94b9ed-05b0-483a-b64a-09ea1cf133cf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c6ad691a-90ca-432a-a13c-6671a57774c5",
"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-11T06:54:21.0421378+00:00",
"date_create": "2026-01-11T06:54:21.0421378+00:00",
"date_update": "2026-01-11T06:54:21.0421378+00:00",
"updated_by_user_id": "2619205e-4646-4ea8-afea-9fe5e9fe78cd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-11T06:54:21.0421378+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-11T06:54:21.0421378+00:00",
"date_last_job": "2026-01-11T06:54:21.0421378+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-11T06:54:21.0421378+00:00",
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00",
"is_mobile_installation": true
},
"job_type_id": "1752e6d7-7b04-4d75-aada-14d1ab70a6ea",
"job_type_code": "sample string 7",
"job_type": {
"id": "6acb95bd-ef66-4efc-95df-6bc58bcf8622",
"name": "sample string 2",
"sales_organization_id": "98979132-6fe6-40cc-9bf5-55b444a6d71f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00",
"code": "sample string 7"
},
"job_priority_id": "e9214ead-930e-4439-bb06-7a9e6673e71d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3a64ce2e-701a-4aae-813e-d168f48bb5ac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "22c9c985-7730-465e-84c5-f9177eec5e85",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"job_status_id": "4868bbeb-e510-4d94-a270-0176b18a11e5",
"job_status_code": "sample string 11",
"db_address_id": "ca08c6ca-8c17-42ef-af8e-9bee0c7c6b8a",
"contact_id": "de5d3454-97cb-4258-ac2f-63010ae3d7af",
"requested_by_company_id": "8dd16be8-b964-4d8d-b8a9-345575a55611",
"requested_by_contact_id": "f6a97444-d871-46d9-90ff-798d6949bbb1",
"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-11T06:54:21.0421378+00:00",
"due_date": "2026-01-11T06:54:21.0421378+00:00",
"date_create": "2026-01-11T06:54:21.0421378+00:00",
"date_update": "2026-01-11T06:54:21.0421378+00:00",
"date_closed": "2026-01-11T06:54:21.0421378+00:00",
"suggested_user_id": "0a45d5ed-5bf4-4abd-b990-b936e58df15f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3a12ecd7-7c1e-43d5-a7dc-43ecf3a9b0ff",
"db_language_id": "a8ae6316-86a5-473f-b5e4-2412a386b5c1",
"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-11T06:54:21.0421378+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "43076c65-98fb-481c-97d1-e6c8694b0959",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2c0a563b-bb0b-4afb-af8b-242d9b463511",
"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": "434ee0bd-a877-4df6-bd73-0bc98b9990af",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e3ead0f3-3067-4758-9587-9278d349b77e"
},
"suggested_date_start": "2026-01-11T06:54:21.0421378+00:00",
"skill_id": "ea85447f-ba34-42e1-af17-a239dbb8b6e6",
"skill_code": "sample string 32",
"skill": {
"id": "7b555eb8-e53b-4a9b-9d1f-afab41901f96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b58f418b-5b71-410e-9f45-1cde95d8f205",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41d521c3-8c90-457e-bb28-8e998001bb43",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68981f46-e95a-46ac-a3da-59654fb0a2e8",
"db_currency_id": "89e257cf-bee2-48a6-b46a-b7d70db68f16",
"db_language_id": "0ea3dabc-6cb1-4fb2-aaae-5bac7a3e0757",
"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-11T06:54:21.0421378+00:00"
},
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0e61dcba-9f77-4b90-80f2-02d526656e50",
"date_reported_by_company": "2026-01-11T06:54:21.0421378+00:00",
"id2": 36,
"company_id": "ecb442c0-9ec3-44a0-b170-54f99a3a2572",
"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": "62ed9f59-3b28-4d3d-b00b-62bf95d3a44c",
"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-11T06:54:21.0421378+00:00"
},
"work_instruction_details_id": "45b37568-9be3-4089-9a57-84754cab537f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "267e7345-a7c8-426e-80ad-5e3af8ba41fb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "021c26fd-94c9-4417-9b94-c7317a3bff97",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-11T06:54:21.0421378+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": "35b5822f-7f67-417f-a46f-285d3e949693",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-11T06:54:21.0421378+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.