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": "352edd4a-d746-433c-8b21-e5c121f43ecc",
"jobs_id": "711c91f4-f9ab-4ced-a400-06781f8d4c6d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "030bca8d-68d9-4065-94ab-a75cf509c18c",
"_parent_id": "408c1561-1906-43dc-a88d-daf836336d6b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "604d007c-8a33-4aef-b1bf-792b5bcd9c29",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4005ab54-24ac-4ef6-8506-89642af1d84e",
"_parent_id": "8a4e1deb-4a80-4474-b94f-3408a7af9c50",
"root_parent_id": "c77d78e4-558e-452f-a181-cd544445e1bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5845640c-55b5-46ac-a4c8-f94db0bfb585",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dd5f08b4-9d56-4125-b2b9-ac5b7299522d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4d5a4ec-5f61-4b0e-bca8-5e40f2277f1b",
"_parent_code": "sample string 6",
"sales_organization_id": "8fd4803a-1b2a-436f-80fa-202600a8e607",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"equipment_model_id": "0468c89e-b056-478a-bed8-fdfd60c9f0be",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8009d73e-4194-48c0-a34c-c421581d1735",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dfa19273-4802-46f0-bb37-fda9a04076c5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e3c4b432-c24b-4f54-999e-f78fcd47b0ec",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "319aa028-3af3-41f1-be77-b0006a489226",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"equipment_family_id": "a2d11b17-e9d1-448a-99e4-cb919bf3261b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dd5f08b4-9d56-4125-b2b9-ac5b7299522d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4d5a4ec-5f61-4b0e-bca8-5e40f2277f1b",
"_parent_code": "sample string 6",
"sales_organization_id": "8fd4803a-1b2a-436f-80fa-202600a8e607",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"date_in_production_since": "2026-05-03T11:44:20.0997476+00:00",
"date_out_of_production_since": "2026-05-03T11:44:20.0997476+00:00",
"date_end_support": "2026-05-03T11:44:20.0997476+00:00",
"sales_organization_id": "0bed5d2d-a429-441f-a86b-8f77288a171a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+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-05-03T11:44:20.0997476+00:00"
},
"project_status_id": "09cd0e4c-6af7-4acc-8fd1-d16df523ce2f",
"project_status_code": "sample string 10",
"project_status": {
"id": "a54677c7-6a46-4e7b-8a3d-63356289868f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "afb61fba-1fd4-448c-aa8d-1e9d12ef6625",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"company_id": "3d1ac029-4c7b-47b2-83ff-89eeb49e8ecd",
"company_code": "sample string 12",
"db_address_id": "b78241c1-a191-42e8-8181-9f5d56a4729c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4933534d-a970-4d16-a0be-7fe8b28fa152",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "869d6dbf-1dc8-4acf-a8b5-34aeaab0cd14",
"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-05-03T11:44:20.0997476+00:00",
"date_create": "2026-05-03T11:44:20.0997476+00:00",
"date_update": "2026-05-03T11:44:20.0997476+00:00",
"updated_by_user_id": "48a3c790-3750-4dd0-a874-af8c2c2f4735",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-03T11:44:20.0997476+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-05-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-03T11:44:20.0997476+00:00",
"date_last_job": "2026-05-03T11:44:20.0997476+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-03T11:44:20.0997476+00:00",
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00",
"is_mobile_installation": true
},
"job_type_id": "3ac42a47-1bc1-4355-8216-3e05642421bc",
"job_type_code": "sample string 7",
"job_type": {
"id": "83af1b28-0765-4035-8b55-464f789871db",
"name": "sample string 2",
"sales_organization_id": "9ec7f540-82fa-49d0-b410-aa1883a81b0b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00",
"code": "sample string 7"
},
"job_priority_id": "4cbc0a93-6bbb-4eb2-b842-17abb3b4042e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cf97166d-a995-45d1-b8de-34c0a81e9ff4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0ba8fae8-cb1b-4e86-a4e2-b28c858bd91b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"job_status_id": "42ac2b2c-70d0-4a0e-9a9f-476c508495b3",
"job_status_code": "sample string 11",
"db_address_id": "e61acdcb-1776-4484-84ea-a15a15e2ae47",
"contact_id": "25b655d4-7e98-4f84-9d75-6733800b5e46",
"requested_by_company_id": "974b53bc-5a2e-43de-a50a-815d754b4fd6",
"requested_by_contact_id": "17759769-d732-4dee-9c9f-9f0b063b29fe",
"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-05-03T11:44:20.0997476+00:00",
"due_date": "2026-05-03T11:44:20.0997476+00:00",
"date_create": "2026-05-03T11:44:20.0997476+00:00",
"date_update": "2026-05-03T11:44:20.0997476+00:00",
"date_closed": "2026-05-03T11:44:20.0997476+00:00",
"suggested_user_id": "364bdae3-5677-4ec0-902e-6cddcca5edf6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "919d228c-2b26-4b58-9ae0-057c869f37e9",
"db_language_id": "b5bf775a-906a-495b-9018-cd1f2f533d8d",
"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-05-03T11:44:20.0997476+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "30634df4-894d-4464-9616-37c1e9f9d3dd",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f88be330-cd96-4cd4-a5d1-28bc9394e623",
"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": "8b3fc826-e8fc-435b-916f-7946fca2d7bb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "21c9bca0-2a85-45e7-8fe7-3c84f1301c33"
},
"suggested_date_start": "2026-05-03T11:44:20.0997476+00:00",
"skill_id": "9c07fc41-2017-4d29-aa3f-89fccba5f22c",
"skill_code": "sample string 32",
"skill": {
"id": "2e1d6a26-ac14-4116-a302-5a9b530da5f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aaf8bf43-7121-4d25-8e69-a977869687ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b67b111f-2d6c-4699-8302-2fde97695d26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daa994b2-ccbf-4610-afd7-847c0dea3919",
"db_currency_id": "78259204-9d99-45be-8126-747ea7dee061",
"db_language_id": "6ee88196-b7f7-47ac-8352-a8f710a9b833",
"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-05-03T11:44:20.0997476+00:00"
},
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8281c9da-1ac6-4909-a102-944076fc34bb",
"date_reported_by_company": "2026-05-03T11:44:20.0997476+00:00",
"id2": 36,
"company_id": "bc08a812-45e9-42d9-b581-b410818f6e0b",
"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": "47f768e3-8c45-4904-8b08-6925f7dfd739",
"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-05-03T11:44:20.0997476+00:00"
},
"work_instruction_details_id": "46c5dcff-a2da-4c4a-b7db-5a92ad64091f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87c603ae-3ca0-4531-8fc3-f834d1cca66d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "068de906-20d7-4fe5-b73d-55b445f79c4b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-03T11:44:20.0997476+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": "4e02065e-167a-48ea-b51e-d3fe24bd583f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-03T11:44:20.0997476+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.