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": "64e79781-ca3c-4c11-b22e-ec23578d2d01",
"jobs_id": "840856e4-cc2d-46e1-9dad-a12958f677bd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "033cf68f-333b-4235-b459-8d49dabcb490",
"_parent_id": "44561dd5-31aa-478a-86e6-0a7aec87dcfa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c171ddd8-fb2f-484e-ad4a-4f8fdeb8d879",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1e0a4264-33c3-4195-a1c7-545a62b74151",
"_parent_id": "31930880-0742-4a2b-a79d-af8c2e3a08f2",
"root_parent_id": "49da92b6-b22e-4213-819c-9534ccc72e04",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9e3c0534-c4b0-41ef-bf66-69f2411c950d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bd8997ef-a4be-4068-b735-f47ab77d8819",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad6e7b07-ad91-4144-b031-3cdd811260b2",
"_parent_code": "sample string 6",
"sales_organization_id": "3e574cfc-2ee5-41f7-aa2a-0e188ba2e82b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"modified_dateutc": "2026-10-14T16:45:52.8802306+00:00"
},
"equipment_model_id": "7e9029c4-1015-40ee-8344-3c5c9301f8a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5feb5bf0-ec75-4aff-a37f-b6cb9f81aaec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "de202b7e-47a1-455a-986d-5479cfee833e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dd2e09a7-d9f8-4e7d-a4ed-77305efdcf14",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4be0b3b3-2fd8-466f-98bf-a9d496c02b9e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"modified_dateutc": "2026-10-14T16:45:52.8802306+00:00"
},
"equipment_family_id": "94d1a184-79f9-43c9-bac6-0e9a40119d3e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bd8997ef-a4be-4068-b735-f47ab77d8819",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad6e7b07-ad91-4144-b031-3cdd811260b2",
"_parent_code": "sample string 6",
"sales_organization_id": "3e574cfc-2ee5-41f7-aa2a-0e188ba2e82b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"modified_dateutc": "2026-10-14T16:45:52.8802306+00:00"
},
"date_in_production_since": "2026-10-14T16:45:52.8802306+00:00",
"date_out_of_production_since": "2026-10-14T16:45:52.8802306+00:00",
"date_end_support": "2026-10-14T16:45:52.8802306+00:00",
"sales_organization_id": "72c5c019-8630-43be-ae74-3a42de110bc0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+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-10-14T16:45:52.8923004+00:00"
},
"project_status_id": "1951851a-c8f5-4d6e-8a8f-7dfa956076be",
"project_status_code": "sample string 10",
"project_status": {
"id": "1b2b6c24-d2f8-4169-a5be-79800ff63240",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a48ae304-b251-4cb0-92ba-019ada49f9a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00"
},
"company_id": "e81826c3-6449-4a51-8ac1-5574d2521ba9",
"company_code": "sample string 12",
"db_address_id": "6ff4a955-0383-4393-a3c4-e7dd054efe2b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b803fa4d-35e1-4978-8e38-484bd5e5ae12",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e9593c4a-3526-4e10-b9d5-0dfd9844aa80",
"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-10-14T16:45:52.8923004+00:00",
"date_create": "2026-10-14T16:45:52.8923004+00:00",
"date_update": "2026-10-14T16:45:52.8923004+00:00",
"updated_by_user_id": "e9f797fe-8961-483e-be10-3918d918dc88",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-14T16:45:52.8923004+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-10-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-14T16:45:52.8923004+00:00",
"date_last_job": "2026-10-14T16:45:52.8923004+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-14T16:45:52.8923004+00:00",
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00",
"is_mobile_installation": true
},
"job_type_id": "93b08540-6678-4ad5-b49d-121a96fa2b89",
"job_type_code": "sample string 7",
"job_type": {
"id": "0b693252-16bb-48e2-9251-538921bab520",
"name": "sample string 2",
"sales_organization_id": "e0dd85c7-a1ad-418c-acf6-aa726518733c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00",
"code": "sample string 7"
},
"job_priority_id": "955848ac-12d7-4f17-bd43-636c9b40f672",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b223106b-8698-41e8-976d-32b2c12bcd56",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "870f3606-ddcf-44f3-a88c-325dcc97181e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00"
},
"job_status_id": "a1c418c7-c1bd-4e9e-beab-0c38bca1cce3",
"job_status_code": "sample string 11",
"db_address_id": "d349ffcc-7690-4d00-9c75-6262a91ab568",
"contact_id": "1ac9de73-5ac9-45a0-962f-1a0f691ee691",
"requested_by_company_id": "a5052598-c5c8-4d43-bf41-63d77c9e13e3",
"requested_by_contact_id": "fada6159-820b-4225-ac87-5e4646bc4fe4",
"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-10-14T16:45:52.8923004+00:00",
"due_date": "2026-10-14T16:45:52.8923004+00:00",
"date_create": "2026-10-14T16:45:52.8923004+00:00",
"date_update": "2026-10-14T16:45:52.8923004+00:00",
"date_closed": "2026-10-14T16:45:52.8923004+00:00",
"suggested_user_id": "674c51ed-6780-48b0-b828-835d8ad3438c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "56d56b16-8349-4297-ade9-0bb105713e37",
"db_language_id": "ba0aca48-68a8-4d12-9abd-3acc1d2c167e",
"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-10-14T16:45:52.8923004+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e6c7aca5-b0c8-4a6d-9508-d43cfbb26a35",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51690eea-24ce-4fda-97b7-026e2519e828",
"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": "b925e34d-5268-438a-b9e5-464ebe1a914c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2373dbf3-0f49-49c7-b829-ab881236c3a4"
},
"suggested_date_start": "2026-10-14T16:45:52.8923004+00:00",
"skill_id": "798cffc4-edcd-4d91-89ce-2802fcd22fd6",
"skill_code": "sample string 32",
"skill": {
"id": "f298dc2d-47ab-40d6-a751-fe9f4dfd1ec9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b275a9f1-3ad9-4259-a962-932b2ffc7501",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5f1974f-02f2-46a7-a7f7-6831cc685531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c83360-9fb0-44ce-956b-4686d3361164",
"db_currency_id": "6037b60c-1bd9-4adf-8a21-594ecae18400",
"db_language_id": "04a7a78f-2b41-4dfc-85df-cee42fd3e52a",
"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-10-14T16:45:52.8802306+00:00"
},
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b0a92d13-fdee-431d-8753-a654e4d6a794",
"date_reported_by_company": "2026-10-14T16:45:52.8923004+00:00",
"id2": 36,
"company_id": "f7cbaa7f-2714-4d8b-a789-70f182edcc5b",
"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": "59ec4044-a6ee-4683-b6e7-fbf28507529d",
"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-10-14T16:45:52.8923004+00:00"
},
"work_instruction_details_id": "03d32529-5865-4f57-98b3-ede85b0da6fb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4ff3293a-2497-4929-926d-17ca5c25b097",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bc7193e5-647f-42d5-9257-c953f9187df5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-14T16:45:52.8923004+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": "d3d46eeb-d8a9-4aed-88db-0a59cc920be4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-14T16:45:52.8923004+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.