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": "7dbfbd14-c945-47b7-a24e-fdbf2dd7569b",
"jobs_id": "e7cb52f1-d3a4-40e0-8461-afdebd6604aa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "10102aa9-640a-40af-88b3-ba7d5cd55587",
"_parent_id": "27665f28-8263-472d-b34e-cfe5ab4edc4b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "345bc304-8819-4d5e-8b01-256ee0d24c0b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b31adbf0-ce77-42dd-8292-909f0bb49102",
"_parent_id": "c31f0159-5e02-4e68-8d1d-f3c99fb03d58",
"root_parent_id": "0a8a4232-3236-4a67-beb4-78917381a6f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "987754e0-6aff-4c54-80e0-82f0845438af",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8625a4f1-e1e8-4f17-bf19-c905a4310214",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86fea00f-7937-43be-a39b-8c389986c124",
"_parent_code": "sample string 6",
"sales_organization_id": "3e6f4475-1dcb-451b-8f2f-330259a7a602",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"modified_dateutc": "2026-07-08T21:22:28.3921129+00:00"
},
"equipment_model_id": "db47a2eb-9088-40f1-b132-cfc3bb2a7035",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4627e890-38f4-4b36-a4f0-f16430196adb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "43b9ae81-2838-40b1-bacd-aa63def5bd1a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6600b2c0-3256-4f06-a7c4-66d540ca487f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9ef39d8e-11b5-4de3-a574-538c3293eb23",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"modified_dateutc": "2026-07-08T21:22:28.3921129+00:00"
},
"equipment_family_id": "20f68a65-c4ec-46b3-9e91-30ef501ed226",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8625a4f1-e1e8-4f17-bf19-c905a4310214",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86fea00f-7937-43be-a39b-8c389986c124",
"_parent_code": "sample string 6",
"sales_organization_id": "3e6f4475-1dcb-451b-8f2f-330259a7a602",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"modified_dateutc": "2026-07-08T21:22:28.3921129+00:00"
},
"date_in_production_since": "2026-07-08T21:22:28.3921129+00:00",
"date_out_of_production_since": "2026-07-08T21:22:28.3921129+00:00",
"date_end_support": "2026-07-08T21:22:28.3921129+00:00",
"sales_organization_id": "983c1fb0-61af-47e3-adb1-1d7386b0dcf9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+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-07-08T21:22:28.3921129+00:00"
},
"project_status_id": "e5fd6752-1486-45c0-a731-91112e20e314",
"project_status_code": "sample string 10",
"project_status": {
"id": "d9416d36-6de4-44c7-89f7-3b5bda69caf3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "696b756e-dbee-4204-969f-b73a5557e753",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00"
},
"company_id": "44504357-e283-4d90-8572-e2bdcd0fea3c",
"company_code": "sample string 12",
"db_address_id": "f9d937b7-36dc-49be-afa2-bc65dd2ccccc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c4de7541-2b38-4e58-bfcf-4bae3168aad7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "909444c2-5326-4243-be82-fabb909ec0f6",
"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-07-08T21:22:28.4077312+00:00",
"date_create": "2026-07-08T21:22:28.4077312+00:00",
"date_update": "2026-07-08T21:22:28.4077312+00:00",
"updated_by_user_id": "4c21505a-97ae-4577-b7b2-58a39ea6844f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T21:22:28.4077312+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-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T21:22:28.4077312+00:00",
"date_last_job": "2026-07-08T21:22:28.4077312+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T21:22:28.4077312+00:00",
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00",
"is_mobile_installation": true
},
"job_type_id": "749ab138-7543-4103-83f2-ffcf87cc9dc8",
"job_type_code": "sample string 7",
"job_type": {
"id": "772b0e7c-1796-48bc-8236-09366a884531",
"name": "sample string 2",
"sales_organization_id": "44c3d0ff-90b6-4ab7-af37-751f5bb2a5ba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00",
"code": "sample string 7"
},
"job_priority_id": "0ef82dba-f939-4f92-86a9-03bad1af0e4c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "66ba469c-ca35-4e6a-9e84-0dd0bdc9cb24",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a59c1bf0-3e13-4be5-9ac9-dbd62741c1f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00"
},
"job_status_id": "3d873288-010d-45cb-8172-d8e0b7f8e492",
"job_status_code": "sample string 11",
"db_address_id": "0615dc46-017c-4c52-aba6-2eb7d03c4f6c",
"contact_id": "ebf831d4-f6bc-4add-8743-7686bd26c914",
"requested_by_company_id": "c7c9d0c5-409f-4dba-a448-ec0462dec930",
"requested_by_contact_id": "20ccb333-a633-4e7c-9238-cdf2b0a2c79b",
"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-07-08T21:22:28.4077312+00:00",
"due_date": "2026-07-08T21:22:28.4077312+00:00",
"date_create": "2026-07-08T21:22:28.4077312+00:00",
"date_update": "2026-07-08T21:22:28.4077312+00:00",
"date_closed": "2026-07-08T21:22:28.4077312+00:00",
"suggested_user_id": "d3b1f8f7-2e6c-4d61-b134-c032ff85bca2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "56c2c218-cb28-4e71-b977-fc8acdbdfff2",
"db_language_id": "46f167e9-9ca3-4ca8-a69e-7716ed0597c9",
"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-07-08T21:22:28.4077312+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "00db44b2-f1ab-4b8e-8d6f-56f8cf4c798e",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7832a700-d49d-4d6e-8787-ae291f47ebe8",
"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": "a6994b83-6b33-4e04-8dea-a9b3e769f226",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95a92071-f7bd-42b9-8c17-b9a71c38fbc3"
},
"suggested_date_start": "2026-07-08T21:22:28.4077312+00:00",
"skill_id": "e196c42f-31a8-4a9f-8428-8bee4eb6c225",
"skill_code": "sample string 32",
"skill": {
"id": "7a770f1c-b69e-4898-b6b9-0c8f4587cb04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7915237f-164f-4438-b8e7-3c1103d527cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "834d5e1f-052e-48c3-a75d-3d3bdb27ba37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfc549c-051c-49d6-966e-b3854c9580f2",
"db_currency_id": "7aad4c8a-e25a-4fb3-8253-d5186d674f59",
"db_language_id": "f39ae168-fceb-435f-b595-7aa12845090e",
"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-07-08T21:22:28.3921129+00:00"
},
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "259aba3a-90c2-4a98-b8d9-b6ba34cc2f18",
"date_reported_by_company": "2026-07-08T21:22:28.4077312+00:00",
"id2": 36,
"company_id": "83299322-8d1f-42d5-9c47-4abc4ea8c938",
"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": "b994cef1-8079-4ba7-87b2-4ecb7b3684f6",
"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-07-08T21:22:28.4077312+00:00"
},
"work_instruction_details_id": "0dca7187-ea57-4fec-ba9d-89f1fb2c4fd9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d30d1022-9b0d-4dff-87f0-5f46c05c0599",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ab4e091c-597a-4d16-9747-323441e35076",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T21:22:28.4077312+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": "46123bdb-56bb-4524-bd9d-5bfe39478961",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T21:22:28.4077312+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.