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": "634af72e-aa40-4b02-8c92-e6524e39c9ce",
"jobs_id": "6fab67f1-fdb7-4ac8-a6c0-1c5b75a3e76a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2bcbe67a-6ad2-4443-aff4-13efa36c09b7",
"_parent_id": "da798dd3-9031-455e-b54b-6359d6f65dc9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b136645d-6766-40df-a522-7949d53824ce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8cb8a135-47f0-4cfd-a0bd-8117a15e516d",
"_parent_id": "182cf3b3-2316-40e7-a38f-4d095b056cf0",
"root_parent_id": "a68aba27-e42b-48a5-9afb-5f9c3c6bf84c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d03aad9b-aa5c-4d23-a4d0-93becc97c7b2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9b7ef45b-d909-4cc2-8c5a-5cb24cb4648b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "069af01f-adaa-4378-9b35-f4a1d11bdaaf",
"_parent_code": "sample string 6",
"sales_organization_id": "41268f78-99d4-4cba-b07f-f507bb5ad854",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"equipment_model_id": "508ec6c3-bf29-4a11-8fce-e5a6dc1a4355",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fab0adcc-4ffd-4f92-9c7e-f733eea849ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9748932e-2ce8-46d7-acea-832619e06430",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "18cb8663-12d2-46cb-9932-997a401de3d2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b17f828b-bfa6-4961-bb20-f09a4b8cf8de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"equipment_family_id": "0e84b667-c414-422d-91c3-abc8310832f8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9b7ef45b-d909-4cc2-8c5a-5cb24cb4648b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "069af01f-adaa-4378-9b35-f4a1d11bdaaf",
"_parent_code": "sample string 6",
"sales_organization_id": "41268f78-99d4-4cba-b07f-f507bb5ad854",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"date_in_production_since": "2026-08-05T06:34:40.631137+00:00",
"date_out_of_production_since": "2026-08-05T06:34:40.631137+00:00",
"date_end_support": "2026-08-05T06:34:40.631137+00:00",
"sales_organization_id": "09354f4d-c2da-4764-9e9d-acb934c23be9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+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-08-05T06:34:40.631137+00:00"
},
"project_status_id": "95a888b9-4cab-4fb3-8c0d-807eda9f486b",
"project_status_code": "sample string 10",
"project_status": {
"id": "cc8d8183-8281-46c3-b79a-7be0a903885d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0fba4e46-9894-4b82-bf4d-4d3543c5f513",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"company_id": "af97e936-9ca8-4cd7-ac26-5ca76b41f1cb",
"company_code": "sample string 12",
"db_address_id": "208af2d7-dc4b-4b72-bcfa-8eaeac303b36",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d0030d65-96b8-445e-8194-142ce158e39d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "36208a5e-c71e-4f64-bf19-5bdcc0231f4e",
"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-08-05T06:34:40.631137+00:00",
"date_create": "2026-08-05T06:34:40.631137+00:00",
"date_update": "2026-08-05T06:34:40.631137+00:00",
"updated_by_user_id": "3f1ae1bb-9068-4a47-8275-53afeef54c1a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-05T06:34:40.631137+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-08-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-05T06:34:40.631137+00:00",
"date_last_job": "2026-08-05T06:34:40.631137+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-05T06:34:40.631137+00:00",
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00",
"is_mobile_installation": true
},
"job_type_id": "e15dbcd3-7533-45f5-9989-7dd155cbc568",
"job_type_code": "sample string 7",
"job_type": {
"id": "17ee101e-a14b-497c-a9c6-295d2e7bd819",
"name": "sample string 2",
"sales_organization_id": "8a9c8fde-04f1-434f-a3e7-3b4f92d0f563",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00",
"code": "sample string 7"
},
"job_priority_id": "77173696-7e51-46ae-b5a8-2eeddcc43d0a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31a764c6-c8a1-4b98-a8e1-ccec1c1ea0d9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e2ce8c49-0d89-4c6f-91aa-8878cb04b82c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"job_status_id": "3e70d2a0-ef34-476b-840c-6dbced05414e",
"job_status_code": "sample string 11",
"db_address_id": "786467de-ad8d-4deb-8c21-4d59c96f5b59",
"contact_id": "3fafaf42-f830-455f-b606-00cfa9b3daeb",
"requested_by_company_id": "c0507408-2827-4dd8-a80e-4e20c6539703",
"requested_by_contact_id": "5458db25-dc88-49cd-955b-cafb2bf68c92",
"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-08-05T06:34:40.631137+00:00",
"due_date": "2026-08-05T06:34:40.631137+00:00",
"date_create": "2026-08-05T06:34:40.631137+00:00",
"date_update": "2026-08-05T06:34:40.631137+00:00",
"date_closed": "2026-08-05T06:34:40.631137+00:00",
"suggested_user_id": "d3bba3b0-3692-4932-b617-96536d2b4ee8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a77d809f-b889-433c-b5cc-2b4098ae4252",
"db_language_id": "56637bc1-217f-4475-9238-486ae9feb806",
"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-08-05T06:34:40.631137+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c4c98f1-1a2a-4772-b161-f2025dc16097",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2033b2a0-90d3-4620-a1b4-a3e87fba38af",
"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": "8ee72d0e-666f-4f08-ac01-0655465a9d1c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8e3a0fbe-daf8-468d-b64d-f96b60057c1b"
},
"suggested_date_start": "2026-08-05T06:34:40.631137+00:00",
"skill_id": "274262af-d77b-4d33-9fce-d842575681d6",
"skill_code": "sample string 32",
"skill": {
"id": "44239eb2-3978-43b5-882e-a36863fa855e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33e8c84b-fb45-4da0-bc03-83580a5f0c31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5737c90-e896-436e-b823-51068f1d684d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31e5755-f19e-4bd7-89fb-d36ce801acb5",
"db_currency_id": "4f465388-7b7b-44b4-aa0d-c751ead80396",
"db_language_id": "2e525b8e-5c3d-4c0d-abf9-6268cfd2f981",
"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-08-05T06:34:40.631137+00:00"
},
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd9122cc-2979-40fd-a9f0-498c1b2a0ebb",
"date_reported_by_company": "2026-08-05T06:34:40.631137+00:00",
"id2": 36,
"company_id": "40a26799-0870-4fc2-954a-ab8c32963ab4",
"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": "16b23f99-aef0-4dfc-a1f3-59b41f06a11e",
"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-08-05T06:34:40.631137+00:00"
},
"work_instruction_details_id": "e807455e-6bfe-4cf0-b93e-f8b7f92420ba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2f944a72-c9bf-4ff3-b1bf-2eea2fe2f555",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f39d7d54-7b88-4a48-b590-fd01bd381e78",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-05T06:34:40.631137+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": "811adcf8-f07a-4181-b9a8-d198545823e2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-05T06:34:40.631137+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.