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": "73cd2505-6c57-4843-b83b-e32f4d55455c",
"jobs_id": "29db3467-cfbe-400d-b08b-c892f7db924b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b9e03cba-06a2-4cb8-bcbb-9432a7ae734a",
"_parent_id": "fc879854-4692-4a61-8406-5b95421d52bb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c7710d14-1f77-425c-929c-95830972c143",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8261c49b-6ed0-480e-89f4-3b2073191b87",
"_parent_id": "ae2bf749-967c-414a-a30e-bffac933c8fa",
"root_parent_id": "77136a38-27f5-4f3b-adf4-2d33c7085d96",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b308e52a-bf79-42bc-b881-39804678500d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0dac0c9-1a56-4a08-85ef-1df8be49f753",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ab98e18-9212-415e-ac4b-38573e727985",
"_parent_code": "sample string 6",
"sales_organization_id": "e5f5eba9-11f3-43d0-a09a-619a140c362d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"equipment_model_id": "24a1d325-0d64-48af-b7be-085da2280407",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "076ec9eb-7311-465e-8ae6-eb6665972ee2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f276c11a-cc32-489d-a1ba-8745225f8b1a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a03d8d32-184b-4850-9368-b4e368eba142",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6e47e1e4-93c0-4187-bccc-2e75bcb941d7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"equipment_family_id": "6579fdf6-ba51-4a72-bf3f-4854bb4f55dc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0dac0c9-1a56-4a08-85ef-1df8be49f753",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ab98e18-9212-415e-ac4b-38573e727985",
"_parent_code": "sample string 6",
"sales_organization_id": "e5f5eba9-11f3-43d0-a09a-619a140c362d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"date_in_production_since": "2026-05-15T15:46:00.8123823+00:00",
"date_out_of_production_since": "2026-05-15T15:46:00.8123823+00:00",
"date_end_support": "2026-05-15T15:46:00.8123823+00:00",
"sales_organization_id": "fd60461f-1aeb-4fa8-844b-0c9814ec746f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+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-15T15:46:00.8123823+00:00"
},
"project_status_id": "13eb47ff-9441-48b8-84f5-4d4d103105c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "c9287d34-66af-48f5-b9f8-4585e11303c2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "608f08b0-00a7-4e0a-89d7-37bb6ab8cbef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"company_id": "aca201c5-926a-4145-afc9-3996ca7e7078",
"company_code": "sample string 12",
"db_address_id": "aaf0ba48-5f86-4ba4-a546-242934988551",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "32b7184c-6964-40b5-ba20-f508304c448d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "398529bf-f879-46f2-b047-af147b7d2241",
"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-15T15:46:00.8123823+00:00",
"date_create": "2026-05-15T15:46:00.8123823+00:00",
"date_update": "2026-05-15T15:46:00.8123823+00:00",
"updated_by_user_id": "b0fdea5d-a92c-4af9-b9d7-0c706ad9a40a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T15:46:00.8123823+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T15:46:00.8123823+00:00",
"date_last_job": "2026-05-15T15:46:00.8123823+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T15:46:00.8123823+00:00",
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00",
"is_mobile_installation": true
},
"job_type_id": "b2eea2e3-a3c3-4a2b-b95c-26445afe6734",
"job_type_code": "sample string 7",
"job_type": {
"id": "4f10226c-dbc6-4383-a806-a21db51c29f5",
"name": "sample string 2",
"sales_organization_id": "1fbc46a6-c789-4224-a35e-ea3cd57af36e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d84508f-0c5b-402a-b11e-545aa741e2d2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "32ab1cb2-968e-4568-bec2-c172368de887",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc898996-c375-43c6-a925-75e917f3055c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"job_status_id": "1939b736-feda-411f-b1c0-998037906f14",
"job_status_code": "sample string 11",
"db_address_id": "b7215696-cf35-4950-9c5f-a7e32fd8071a",
"contact_id": "ebe9d7b7-dbc0-47ab-8886-8d7a5487d855",
"requested_by_company_id": "8321e994-9295-4752-a32c-886212a6dbfb",
"requested_by_contact_id": "4a87ee7f-e839-4386-b10e-47d1ea13da9d",
"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-15T15:46:00.8123823+00:00",
"due_date": "2026-05-15T15:46:00.8123823+00:00",
"date_create": "2026-05-15T15:46:00.8123823+00:00",
"date_update": "2026-05-15T15:46:00.8123823+00:00",
"date_closed": "2026-05-15T15:46:00.8123823+00:00",
"suggested_user_id": "c7b78192-c53a-49e2-921a-bca0c05f3517",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "949dba5e-3e4b-4337-82b0-31354c2111d9",
"db_language_id": "222481ef-bf7a-4883-a588-3d7fb8f4f28c",
"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-15T15:46:00.8123823+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a4d5e9f-43d0-446a-b359-f2ce9407a1b3",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "49a35247-05db-4750-bf76-35229246cefe",
"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": "ef12dfd6-3bf5-4c48-a1a6-092e04760833",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ba05075c-2e11-412d-92bf-6524637116f6"
},
"suggested_date_start": "2026-05-15T15:46:00.8123823+00:00",
"skill_id": "6d83dfc8-a629-4837-8c82-d5184600950a",
"skill_code": "sample string 32",
"skill": {
"id": "d8284075-4f04-43ba-a4c0-4490f504f614",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "89743a01-9ac7-46cb-82bd-d01e064264d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5fc2da6-1b10-4c42-ae24-7d393ee46ef9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99ae697f-fd7f-47b1-a141-c16126380772",
"db_currency_id": "d2976fb7-08ba-4071-83ab-ea46a8a22b6b",
"db_language_id": "3ec5627c-9297-4020-9268-510e59b824ee",
"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-15T15:46:00.8123823+00:00"
},
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0522919b-f4f9-4611-ad01-bd5452c1075d",
"date_reported_by_company": "2026-05-15T15:46:00.8123823+00:00",
"id2": 36,
"company_id": "094cc594-d573-48fd-adbe-2fe74e32bf6d",
"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": "1f5d7831-a6e2-49ad-96a4-de9349e1f731",
"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-15T15:46:00.8123823+00:00"
},
"work_instruction_details_id": "b2e2d1ac-aaf6-4d19-bc7f-2cf8084879a7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1263d299-8259-462e-ab45-a628d49fa41d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5806dfc2-68a7-40c0-a1a5-810692b85111",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T15:46:00.8123823+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": "765fe944-3cb7-4a35-88a0-9873f31ba591",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T15:46:00.8123823+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.