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": "ef437ee0-6af8-4a3e-862d-ff19eefa4a78",
"jobs_id": "f466af93-4f09-42ef-bbcd-968d3b0c4825",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bed97119-e858-41d6-93ab-ac295be0f592",
"_parent_id": "00b6e269-9258-43bb-8993-9519bcb95dd0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f2872ca4-0555-49a7-a793-b0a42a4457a8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "409ae5c9-9d64-4939-a772-feafa19df0d3",
"_parent_id": "2c812e74-ddc0-448c-ab26-d8b55b538049",
"root_parent_id": "a566ef9f-9a46-4752-831f-ad3a6b35a409",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9390c72f-a918-4935-998d-33c102d8b308",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b756813a-5ef5-48ed-aaa8-5d2ee203716a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94724d44-237a-4616-bf05-697a8e8057a2",
"_parent_code": "sample string 6",
"sales_organization_id": "8aff4c3a-b8f2-425d-9da7-004461ca3fcd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"equipment_model_id": "21104560-8db1-471c-987a-7223842f64e2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e6e5dd6-554f-47aa-9595-3dc787fddf70",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8a05bcb8-5a77-4a60-a15a-d1b2f82f7b41",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0755ac15-010f-4b1b-a619-5918a9fa2eda",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0ac8a56d-fa81-43ce-9c5d-d100f234bcdd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"equipment_family_id": "0588fee7-e6c5-4850-aa68-2ae29f70ac3d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b756813a-5ef5-48ed-aaa8-5d2ee203716a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94724d44-237a-4616-bf05-697a8e8057a2",
"_parent_code": "sample string 6",
"sales_organization_id": "8aff4c3a-b8f2-425d-9da7-004461ca3fcd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"date_in_production_since": "2026-08-17T19:11:48.9102549+00:00",
"date_out_of_production_since": "2026-08-17T19:11:48.9102549+00:00",
"date_end_support": "2026-08-17T19:11:48.9102549+00:00",
"sales_organization_id": "03f1c2b8-f90b-4dac-83e4-ade50588d63b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+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-17T19:11:48.9102549+00:00"
},
"project_status_id": "ca8ec942-e6c9-4386-8cd3-3456d12d36ae",
"project_status_code": "sample string 10",
"project_status": {
"id": "60a520d7-e38f-4c3d-86d7-7bba9d918ee7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94adf696-447f-4c91-8910-c8392c838c79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"company_id": "eea21fc8-164e-48b3-9ba2-b46b7cbada98",
"company_code": "sample string 12",
"db_address_id": "4ddfa854-7153-4dd0-bd64-5d79a587e557",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11c835da-19e4-4cb3-a074-3ea0be3ca2b5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dbe7e56f-4c59-49ca-80a3-e6e0b053e9fa",
"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-17T19:11:48.9102549+00:00",
"date_create": "2026-08-17T19:11:48.9102549+00:00",
"date_update": "2026-08-17T19:11:48.9102549+00:00",
"updated_by_user_id": "c905f42a-b967-4fc6-869e-98465896369c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-17T19:11:48.9102549+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-17T19:11:48.9102549+00:00",
"date_last_job": "2026-08-17T19:11:48.9102549+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-17T19:11:48.9102549+00:00",
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00",
"is_mobile_installation": true
},
"job_type_id": "61bad2a0-fcdd-4e91-8192-65dab3947400",
"job_type_code": "sample string 7",
"job_type": {
"id": "5bd1e16b-8916-4525-bced-3a530880cd6b",
"name": "sample string 2",
"sales_organization_id": "690e6ec7-05df-498b-9cff-7d7376185e71",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00",
"code": "sample string 7"
},
"job_priority_id": "52c1744e-0ea0-44ce-8966-7297fbffb421",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fe293ff4-119c-4aa5-bd53-47edd4641c88",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "585321ef-f26e-4c0f-8df1-45e9c36c7189",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"job_status_id": "6e28c498-e8e2-4a54-9d6c-22c2355c0abb",
"job_status_code": "sample string 11",
"db_address_id": "2c7d361c-fce4-41d0-9ddf-4a76fba31727",
"contact_id": "de0fb7b7-57ca-4077-8f8e-a02c4312866e",
"requested_by_company_id": "8da3806e-da0a-4446-bb19-a8695a3cd2ff",
"requested_by_contact_id": "a4caa849-5ed9-4cf4-841d-aee53d191d0f",
"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-17T19:11:48.9102549+00:00",
"due_date": "2026-08-17T19:11:48.9102549+00:00",
"date_create": "2026-08-17T19:11:48.9102549+00:00",
"date_update": "2026-08-17T19:11:48.9102549+00:00",
"date_closed": "2026-08-17T19:11:48.9102549+00:00",
"suggested_user_id": "226af398-fb08-41c4-928d-4875c67e450f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa9b98ac-c836-4fb0-b8ed-d6886205db01",
"db_language_id": "e200d87f-4b66-40b4-831c-acb72b92d62c",
"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-17T19:11:48.9102549+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0c208d9f-2b3a-476a-86d1-19ece5c3f7e7",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4433131b-702d-4b52-9679-d65448346c60",
"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": "b31be3e2-9549-4b42-b871-0660771af3db",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ffeb64e-6bed-4879-97d8-072bbdb55d5e"
},
"suggested_date_start": "2026-08-17T19:11:48.9102549+00:00",
"skill_id": "22088764-6e85-4515-8409-4790ecaa2d2d",
"skill_code": "sample string 32",
"skill": {
"id": "5233a38b-d051-46eb-aaee-eb9b869d132e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1eafaa80-db0a-4471-b73c-54e220cfedfd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc1e11ec-611b-4c8d-9ea5-b928b7f2c6c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d7074a-84c4-4528-bd41-22f5198a063a",
"db_currency_id": "87c4ddaa-410d-420a-addc-2ffb48936ccb",
"db_language_id": "a954ddff-4d00-42b5-b80b-ce9ca258eac3",
"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-17T19:11:48.9102549+00:00"
},
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "125fa8ea-468d-4029-89e6-f94ada1dbc18",
"date_reported_by_company": "2026-08-17T19:11:48.9102549+00:00",
"id2": 36,
"company_id": "ec618d70-2897-442a-89b7-fe58a4237adc",
"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": "e8683f74-5b56-4bb9-88d4-2e313412c8fd",
"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-17T19:11:48.9102549+00:00"
},
"work_instruction_details_id": "7585b382-2fe4-49a3-8868-adf87e6ddb08",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5c886313-e207-47c2-a2fa-6c7639a8716a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f538d6c1-32bc-4f1e-a748-2820efadc011",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-17T19:11:48.9102549+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": "d4888479-3f59-4ec6-9efc-4128a4da49f6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-17T19:11:48.9102549+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.