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": "6e86c580-b2a4-48f0-b288-eb3895967fd3",
"jobs_id": "2ebcc363-aba8-42a4-be6a-1a1984e2dad6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "62a7a492-c704-4177-ba76-365072624ce3",
"_parent_id": "fa4cc7e7-9c8a-412e-9c16-68ab1efc5ce0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "553f2bd9-4665-415b-be6e-d0e82aa51a4c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "82df3ec4-e758-4a11-851b-c4713e6c5171",
"_parent_id": "22d3385d-5ab4-48eb-858f-949922037ca5",
"root_parent_id": "385f30a7-91b2-4caf-b951-a7add63c3a2e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d79c6e48-ae44-4541-bfa3-b8f09c55e4fd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "084a5cd1-0ece-4565-a496-f56ea69ed05b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ebe6bdbe-d70b-467a-86fa-d6eb8d1af5c2",
"_parent_code": "sample string 6",
"sales_organization_id": "9cbe4af9-99f7-41ac-a048-ec768424cca2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"equipment_model_id": "2fa62343-624f-4399-955e-3a1347ce4b50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "678b9036-1b17-4c47-a85c-4882bcf3e911",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "af811bf3-264c-411a-9f96-0927ad6ceb40",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e47e08b4-893d-409c-b2ae-d28db84dbf80",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ebdb57b2-29aa-4359-b804-13420e0e45ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"equipment_family_id": "789cf4db-b97d-48d1-b55e-a2e2b3799c58",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "084a5cd1-0ece-4565-a496-f56ea69ed05b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ebe6bdbe-d70b-467a-86fa-d6eb8d1af5c2",
"_parent_code": "sample string 6",
"sales_organization_id": "9cbe4af9-99f7-41ac-a048-ec768424cca2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"date_in_production_since": "2025-05-16T16:52:05.2822415+00:00",
"date_out_of_production_since": "2025-05-16T16:52:05.2822415+00:00",
"date_end_support": "2025-05-16T16:52:05.2822415+00:00",
"sales_organization_id": "62dd75a1-65c3-4e41-9251-2b367d48889f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+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": "2025-05-16T16:52:05.2822415+00:00"
},
"project_status_id": "c6b2f45a-07d4-4cbd-a38b-5a7f42cd5135",
"project_status_code": "sample string 10",
"project_status": {
"id": "fd89a97c-6ddf-440b-bc56-1146b4c14924",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a9fee703-e3df-4446-8983-6635227b92c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"company_id": "88e8cd7d-87a7-436d-a647-6d28f5da267c",
"company_code": "sample string 12",
"db_address_id": "4d7da2e7-25b5-4bcf-9f3a-16391d6feca3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d79cb04b-fa3a-43ec-a5eb-1223b91e9abf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "09530415-f470-48ed-b166-42540689bbad",
"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": "2025-05-16T16:52:05.2822415+00:00",
"date_create": "2025-05-16T16:52:05.2822415+00:00",
"date_update": "2025-05-16T16:52:05.2822415+00:00",
"updated_by_user_id": "1a4e32c6-0645-4937-bb63-ffc91c1df461",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-16T16:52:05.2822415+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": "2025-05-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-16T16:52:05.2822415+00:00",
"date_last_job": "2025-05-16T16:52:05.2822415+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-16T16:52:05.2822415+00:00",
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00",
"is_mobile_installation": true
},
"job_type_id": "0693be49-dcf6-421f-80a2-949735150d9f",
"job_type_code": "sample string 7",
"job_type": {
"id": "739fd305-96cb-493c-847b-d26313bf4c95",
"name": "sample string 2",
"sales_organization_id": "4a0d4648-a8d1-4cec-a8cd-129d2efea203",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00",
"code": "sample string 7"
},
"job_priority_id": "4b9fa29a-0ca6-43b0-8ddf-229969a4c71a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cd708089-3030-44b7-b47f-806ed202cfed",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c4f5c9be-f675-4106-b8e3-663ff050a499",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"job_status_id": "8bec48c6-765a-464c-b841-eb6b5cae36c4",
"job_status_code": "sample string 11",
"db_address_id": "aa5ca520-256a-4b96-a730-bef6de765550",
"contact_id": "73dde3ac-19f1-4774-a675-19321078bf3b",
"requested_by_company_id": "3c87cfd2-ccec-4b53-ac1c-514be25bf897",
"requested_by_contact_id": "57b373f6-3ff6-4cba-8cbf-d4c53a4cd99e",
"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": "2025-05-16T16:52:05.2822415+00:00",
"due_date": "2025-05-16T16:52:05.2822415+00:00",
"date_create": "2025-05-16T16:52:05.2822415+00:00",
"date_update": "2025-05-16T16:52:05.2822415+00:00",
"date_closed": "2025-05-16T16:52:05.2822415+00:00",
"suggested_user_id": "4f8bc3e6-edb9-4b8b-937c-b2d76203be9f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f17f0ad3-2345-4b89-9bb0-77c35cbd566f",
"db_language_id": "3ad07485-4a5c-4246-b468-1cbc833d1c48",
"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": "2025-05-16T16:52:05.2822415+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "81d22114-bd59-4e29-8bd0-cfcdc1813cc1",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "32545fc2-e2bb-41cc-a4a1-8ee4eba10448",
"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": "f0872a3c-ec2c-45b2-8a10-a8d29d097e1d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1b6afdb6-c028-43ef-8bae-33a9fe574d5d"
},
"suggested_date_start": "2025-05-16T16:52:05.2822415+00:00",
"skill_id": "f243db0c-8224-4180-95e3-35b9312ff0c3",
"skill_code": "sample string 32",
"skill": {
"id": "e903b015-9133-4b8f-a9ce-0d9fb4597dc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0158f1b9-e7c3-49cb-8e40-af60a28d2f8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0981dfc-19df-45c6-a2c4-bad3c5b79151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49b493f2-3195-4011-b5a8-661bd528cc37",
"db_currency_id": "74cd91a5-982e-48bb-a40b-9a59e9edb6d4",
"db_language_id": "680513b7-2f73-402c-bd08-2afc6c8dabdc",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "df4da0b9-e9c7-491c-bd52-e1cd1e7d903a",
"date_reported_by_company": "2025-05-16T16:52:05.2822415+00:00",
"id2": 36,
"company_id": "2aaec7ec-23de-4fc0-989d-ba39f367a295",
"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": "8b422362-bfcd-4dda-bbdb-808b7398cba7",
"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": "2025-05-16T16:52:05.2822415+00:00"
},
"work_instruction_details_id": "f75481a2-d624-4be7-bfb9-39c1bdd0c377",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "26f8be94-940b-4c60-8806-05a8eaa363ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29bbbd5f-9982-420b-b9ff-e82b6dbf0b0b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-16T16:52:05.2822415+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": "f3b0e9a6-46ea-4b8b-a733-01dada5b1299",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-16T16:52:05.2822415+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.