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": "ee7b64ab-9311-452a-93db-a392cd752e86",
"jobs_id": "808f801e-ae20-4a08-9b87-dee60f02ec11",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a13f9a4-5941-41ab-96fe-f4660d8344e7",
"_parent_id": "98844ae1-9224-493b-a2ac-f4c46d4e96a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "23f24813-ee33-4eb4-b9fc-0c99f3325b97",
"project_reference_back_office": "sample string 5",
"project": {
"id": "50b06442-5bcc-4705-9cf6-aa5c0b24c8b2",
"_parent_id": "ea5995f6-cb90-46fd-ab58-aeef2f5df4c9",
"root_parent_id": "1e25397d-ae86-4534-9910-e4d5da8797c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15fa3a56-a55c-4c0d-9006-040f14b47604",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4d8cd705-bc78-48b6-8c2b-e69f8a411447",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cbc6d69-43ad-444b-a557-478f531ec6a8",
"_parent_code": "sample string 6",
"sales_organization_id": "f5e256ce-7893-48f4-9b62-b5a1a4543a95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00"
},
"equipment_model_id": "434208b3-c078-4e75-a38e-50f5bb8bf50c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "de7d6355-6771-49c8-9eee-bb498f66781b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5551f55a-018e-4225-bb28-5fa634fac197",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c7722a5f-4b6c-4b64-90a6-12f7d713bc82",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "574bb8a5-05ab-40d7-a9ab-21e541686ae5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00"
},
"equipment_family_id": "75bdfec0-b783-4298-a11a-52e67fcf9d1b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4d8cd705-bc78-48b6-8c2b-e69f8a411447",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cbc6d69-43ad-444b-a557-478f531ec6a8",
"_parent_code": "sample string 6",
"sales_organization_id": "f5e256ce-7893-48f4-9b62-b5a1a4543a95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00"
},
"date_in_production_since": "2026-02-06T04:54:17.847157+00:00",
"date_out_of_production_since": "2026-02-06T04:54:17.847157+00:00",
"date_end_support": "2026-02-06T04:54:17.847157+00:00",
"sales_organization_id": "97617cb8-88cb-4760-934e-808799348c91",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+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-02-06T04:54:17.847157+00:00"
},
"project_status_id": "a1d278bb-479c-4dfa-b788-bf3002e6ab64",
"project_status_code": "sample string 10",
"project_status": {
"id": "6f038531-8394-4986-9af1-bd30d80abb6b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6c400784-f0af-4c59-982b-51c11d6948ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00"
},
"company_id": "8c9c8dda-1920-4f7f-b81f-7d8ff330e414",
"company_code": "sample string 12",
"db_address_id": "ab856187-3a41-4d92-8c5d-65779eeef63b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "10597932-a697-43a5-834a-c72e87025446",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a718b787-b86a-4093-b2b6-6ef353bb81d8",
"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-02-06T04:54:17.847157+00:00",
"date_create": "2026-02-06T04:54:17.847157+00:00",
"date_update": "2026-02-06T04:54:17.847157+00:00",
"updated_by_user_id": "9a2db4ad-3f60-4e18-b8c5-53f274645982",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-06T04:54:17.847157+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-02-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-06T04:54:17.847157+00:00",
"date_last_job": "2026-02-06T04:54:17.847157+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-06T04:54:17.847157+00:00",
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00",
"is_mobile_installation": true
},
"job_type_id": "15f0961c-042c-4d46-8981-01e5c0f304bd",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ce1a86e-c23d-44e4-94d2-b8e45005c82e",
"name": "sample string 2",
"sales_organization_id": "fc025bbb-c998-4a21-9a4b-5c843b1f65af",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00",
"code": "sample string 7"
},
"job_priority_id": "670c67e6-91e7-4b4d-ac13-4095a702eeea",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "287d565e-467f-4a75-9d05-bec117366b84",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ae9216a8-8258-461d-90df-72c1848518be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-06T04:54:17.847157+00:00"
},
"job_status_id": "d040d56d-b352-4713-b88d-bf4c6df7f7f7",
"job_status_code": "sample string 11",
"db_address_id": "bd3fe6f6-1f92-432a-8a45-df240f37a03a",
"contact_id": "6b84c1f9-ee9f-405a-946e-e590913fe05e",
"requested_by_company_id": "dbf701f1-8351-483d-be66-8b9a4acff9d9",
"requested_by_contact_id": "b751de27-c2a5-4e72-adad-ca653b0c5a3e",
"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-02-06T04:54:17.847157+00:00",
"due_date": "2026-02-06T04:54:17.847157+00:00",
"date_create": "2026-02-06T04:54:17.8627802+00:00",
"date_update": "2026-02-06T04:54:17.8627802+00:00",
"date_closed": "2026-02-06T04:54:17.8627802+00:00",
"suggested_user_id": "5ee0a422-cbf2-4c1a-9354-d454c6e613f2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1963538-2251-46fd-8333-778228f19ab3",
"db_language_id": "85856bd9-1884-4c7b-8d05-99c44927e2a8",
"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-02-06T04:54:17.8627802+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fa7da8d6-1e15-470a-8582-6772c4e9e788",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f898c6e6-625b-4b57-b89e-3307388aa2ad",
"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": "605b8bca-38dd-4498-811a-cf9db7ed8544",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-06T04:54:17.8627802+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eff2a4b2-943e-4a0b-907a-920cea854455"
},
"suggested_date_start": "2026-02-06T04:54:17.8627802+00:00",
"skill_id": "fb3cd18c-c59b-4568-874a-c19a76ca032e",
"skill_code": "sample string 32",
"skill": {
"id": "3f87bc5f-97c9-4301-9935-411ee84d70d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f2089c7c-4ac0-444b-a2e6-4adf65c7f44a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c073be07-e875-4a86-a5ae-e82b3dbc0629",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "948586b2-2ac5-4b35-8f9c-14fd9cbde644",
"db_currency_id": "42e7d6fc-caa9-44ee-84be-7fc9f1a7cfb6",
"db_language_id": "e42d1e75-2a9a-4935-b383-ca135dc20994",
"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-02-06T04:54:17.847157+00:00"
},
"modified_dateutc": "2026-02-06T04:54:17.8627802+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "65e7dcea-ab1a-4c17-b4a9-2f882df01bc3",
"date_reported_by_company": "2026-02-06T04:54:17.8627802+00:00",
"id2": 36,
"company_id": "5e981cc0-53e0-4092-bc0a-248346bed73f",
"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": "34e9a707-f0fc-481f-997c-c2bf9e116d3c",
"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-02-06T04:54:17.8627802+00:00"
},
"work_instruction_details_id": "eba71630-a68d-442a-af5b-5accd4b1276a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e32fa38-8932-4034-b291-e3ac27513d06",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8d98be22-45a4-47a6-aac6-e078dda5c7d6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-06T04:54:17.8627802+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": "03f4f201-cc11-43f7-af3e-eb6c547e2d11",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-06T04:54:17.8627802+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.