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": "8f28a486-c426-4210-ae17-4a2b2c4d8aa8",
"jobs_id": "f7c746fa-2d6e-4f39-9c1b-9c80688fd421",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6881fcf8-29ca-4b3c-a4a4-41a4ca73da2e",
"_parent_id": "22214d14-40b3-4ae5-b20b-96ad874af0c0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aaa56fd6-26bb-481f-9206-aa247f4eb003",
"project_reference_back_office": "sample string 5",
"project": {
"id": "46732592-cce8-47dd-8731-34fa7816934d",
"_parent_id": "5bb99242-4fa8-4ea7-a959-45d8a04a5ee1",
"root_parent_id": "a7281e66-ba70-4dcd-86b4-b768f96f1c94",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a45a6d6e-784d-43fb-b026-797d16622a12",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9e4dcc3a-1676-4c76-b223-9aa484aa6c99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b98795f-09ed-4b04-bbf6-a8f5f72e6671",
"_parent_code": "sample string 6",
"sales_organization_id": "34d7cb41-f124-4998-85fa-5dd6dc744164",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"equipment_model_id": "5ad31a8e-ee62-47a4-bf2e-3f247fddca17",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "678741ba-178b-4bd2-9fc2-c280ba2f5b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f897e1d3-bbd3-4276-9ec8-8117f70d17ed",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2d5b7b57-febc-4d69-b459-575fc40b41be",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "117068e7-9779-47ca-b202-6a1ffec2c9bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"equipment_family_id": "52097e78-eff4-41fe-9525-e761c8af6e74",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9e4dcc3a-1676-4c76-b223-9aa484aa6c99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b98795f-09ed-4b04-bbf6-a8f5f72e6671",
"_parent_code": "sample string 6",
"sales_organization_id": "34d7cb41-f124-4998-85fa-5dd6dc744164",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"date_in_production_since": "2026-09-16T18:52:00.3477155+00:00",
"date_out_of_production_since": "2026-09-16T18:52:00.3477155+00:00",
"date_end_support": "2026-09-16T18:52:00.3477155+00:00",
"sales_organization_id": "52cd7148-42b9-4f20-a464-dcf0f72e0b29",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+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-09-16T18:52:00.3477155+00:00"
},
"project_status_id": "91aedbd5-b686-46f8-a3d3-f1ea05f48e1d",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b236f17-c0cc-4723-9e9c-e2c7c373e5eb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "30639321-3d32-46e1-b3ea-1990491f50aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"company_id": "20fe2398-aade-41b5-a863-e38be20318f8",
"company_code": "sample string 12",
"db_address_id": "9cbd8bd1-7890-43e3-af08-2809421346a5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84f9b596-602b-41e4-9a1c-58a00febd972",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6d928abd-4942-4ab9-b6ae-e3f9e392c384",
"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-09-16T18:52:00.3477155+00:00",
"date_create": "2026-09-16T18:52:00.3477155+00:00",
"date_update": "2026-09-16T18:52:00.3477155+00:00",
"updated_by_user_id": "a3a5d79c-5ecc-4994-ad0a-62c95f08109b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-16T18:52:00.3477155+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-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-16T18:52:00.3477155+00:00",
"date_last_job": "2026-09-16T18:52:00.3477155+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-16T18:52:00.3477155+00:00",
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00",
"is_mobile_installation": true
},
"job_type_id": "82df2b57-081a-4f7f-b7c5-538b1ae23e26",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c22e457-dd52-4183-b16c-9e087b410941",
"name": "sample string 2",
"sales_organization_id": "b6671711-4b31-42b5-849f-a1591f6380fd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e005cc4-e922-4f94-a728-5539e21a97c7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "adbc1dd1-8226-4c93-9d9d-9554afdd502e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2896ac47-14e0-4d47-8017-72ff52ed05c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"job_status_id": "b8bc751d-75ff-4142-9483-5bb91518d423",
"job_status_code": "sample string 11",
"db_address_id": "c99bb737-3bea-4d93-8ab2-13db97c8f5f6",
"contact_id": "d7c96392-d5e3-485e-878f-131aba49d581",
"requested_by_company_id": "55e7b8f0-1910-41b4-a50d-6be8d55f6b4f",
"requested_by_contact_id": "22f01175-de78-48b9-85f9-8f56e6876682",
"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-09-16T18:52:00.3477155+00:00",
"due_date": "2026-09-16T18:52:00.3477155+00:00",
"date_create": "2026-09-16T18:52:00.3477155+00:00",
"date_update": "2026-09-16T18:52:00.3477155+00:00",
"date_closed": "2026-09-16T18:52:00.3477155+00:00",
"suggested_user_id": "35cb0335-dcc1-4ad8-8917-78465f3d5ab9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fcc2db67-9582-46b6-bb49-f2b6ecdf1fe4",
"db_language_id": "d725639f-d831-4c0c-b1f8-abe0d953aec1",
"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-09-16T18:52:00.3477155+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "56db5636-2507-492d-a1dd-fc1e400c288c",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "387a1fad-e071-4739-8e57-5041a276840a",
"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": "091818a0-1709-4429-8d83-616302e89fcd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c8c5fa36-d87f-4fe2-b05a-b7ab2b51aa50"
},
"suggested_date_start": "2026-09-16T18:52:00.3477155+00:00",
"skill_id": "c25a6fc3-acfb-485c-bf35-1ec5826f2e4e",
"skill_code": "sample string 32",
"skill": {
"id": "98a1ac9e-df10-4057-8995-335d621d4490",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7d967e6b-7ae5-489c-bd70-890556a7799c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb7e651f-6f31-4671-b1de-3d99015068f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f78c6c-fadd-4708-877a-9f0f127b6492",
"db_currency_id": "c11288fe-c071-44cb-b9bb-eba71de5bca7",
"db_language_id": "1cefd8e1-d64a-4ab4-a665-c55ad951433a",
"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-09-16T18:52:00.3477155+00:00"
},
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "10a396b1-76b4-4f1e-896a-3a5d2becb9b6",
"date_reported_by_company": "2026-09-16T18:52:00.3477155+00:00",
"id2": 36,
"company_id": "b2c27fa0-62ed-4534-91df-83ab21be11d9",
"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": "56ee3a8a-e3ed-4216-ad50-cc24497b6349",
"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-09-16T18:52:00.3477155+00:00"
},
"work_instruction_details_id": "45638d9b-0853-4115-b5b2-6afa8bd2150d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e755647c-5175-4694-b5de-8a0349acffa0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c7355b0f-933d-480e-bb7d-1ae7278e87d3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-16T18:52:00.3477155+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": "c29267b9-f9b4-49af-9e56-d3af25a53a3d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-16T18:52:00.3477155+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.