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": "4d86a226-17f5-449a-99fc-7ebec9be2475",
"jobs_id": "d1eee82e-4a98-4bad-82f7-dab70bfa9a5d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8fa80491-20ce-484e-ba76-994e54c160cb",
"_parent_id": "5c49bd5f-7e6a-438c-b296-0120d095aec0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "face6f61-b2d5-4302-a44c-bb1e947985be",
"project_reference_back_office": "sample string 5",
"project": {
"id": "63dc325e-be55-4ba4-a8f8-1bb04bed3010",
"_parent_id": "0f202939-2f63-48ac-8ed1-caee38260b49",
"root_parent_id": "0c6fcdc1-1ddd-462e-98f8-30f55b875561",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "050ab208-fb43-4032-bd60-25750820394e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cd026dc8-1117-459a-ba1c-b8c0f5e04247",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82e2c533-374c-4be2-a4b4-d1016e6a4119",
"_parent_code": "sample string 6",
"sales_organization_id": "08a6e291-20cb-4f1d-9ff0-c82a10d8c95c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"equipment_model_id": "370c45b3-b3c7-43b5-af2c-e220ceacf6f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "44bae4bf-e266-43fc-87d6-ebeca3d43199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "88643ba6-0ec5-4b34-bfdf-6a560a381600",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d84b50d9-7536-489d-a0cc-5c3958a0d8e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f3b54c04-d178-436f-9c1c-d2fec47af5fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"equipment_family_id": "98f66f24-538e-4136-acbb-400bfb316ee9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cd026dc8-1117-459a-ba1c-b8c0f5e04247",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82e2c533-374c-4be2-a4b4-d1016e6a4119",
"_parent_code": "sample string 6",
"sales_organization_id": "08a6e291-20cb-4f1d-9ff0-c82a10d8c95c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"date_in_production_since": "2026-06-02T03:50:10.6532783+00:00",
"date_out_of_production_since": "2026-06-02T03:50:10.6532783+00:00",
"date_end_support": "2026-06-02T03:50:10.6532783+00:00",
"sales_organization_id": "39fb58ab-f6fd-43c0-bdaf-060e7b1c3eac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+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-06-02T03:50:10.6532783+00:00"
},
"project_status_id": "185ef0e5-0e55-4a50-ab20-9ef61bf75ad3",
"project_status_code": "sample string 10",
"project_status": {
"id": "6fe122fd-14b4-4047-ad94-3a982cb26e4a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "25d8353d-d116-4387-9cc4-9ba278781c16",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"company_id": "bb3d9980-8a7a-4325-8876-830163edd792",
"company_code": "sample string 12",
"db_address_id": "2294401c-033c-4df7-863b-c0aa66142128",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11f48797-7170-4c1e-b064-9fef62d93595",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2ae248e6-1452-44b9-a623-1d314062065c",
"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-06-02T03:50:10.6532783+00:00",
"date_create": "2026-06-02T03:50:10.6532783+00:00",
"date_update": "2026-06-02T03:50:10.6532783+00:00",
"updated_by_user_id": "ab85ddee-5b55-4cbe-9605-42cdbba2c502",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:50:10.6532783+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:50:10.6532783+00:00",
"date_last_job": "2026-06-02T03:50:10.6532783+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:50:10.6532783+00:00",
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00",
"is_mobile_installation": true
},
"job_type_id": "2efc2ca9-2b2b-4186-a512-bb77b8c73702",
"job_type_code": "sample string 7",
"job_type": {
"id": "e217b7e3-8800-4aa9-bb02-0b5619132498",
"name": "sample string 2",
"sales_organization_id": "f4eee0d3-fb80-40f9-82c4-0430a8828557",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00",
"code": "sample string 7"
},
"job_priority_id": "a2a792fb-9d86-47fe-9b3c-d6f26ed6bca0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7ccfba8-f30c-42bc-ae5d-dc883b1f908c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "be760417-decf-43a8-a365-e1130c177718",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"job_status_id": "20e2c9cc-d3d9-4b80-8449-f8667fedfef0",
"job_status_code": "sample string 11",
"db_address_id": "d5958005-dbd2-4f21-bb0f-f20cb111ef2e",
"contact_id": "5b1cef64-a4d3-4cee-8e0d-fb0c4e93767a",
"requested_by_company_id": "38ad2a55-9ec4-430e-95e9-f20e9bf48283",
"requested_by_contact_id": "8bc4889d-5baa-4fb1-99a1-a0d9b2b7ad94",
"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-06-02T03:50:10.6532783+00:00",
"due_date": "2026-06-02T03:50:10.6532783+00:00",
"date_create": "2026-06-02T03:50:10.6532783+00:00",
"date_update": "2026-06-02T03:50:10.6532783+00:00",
"date_closed": "2026-06-02T03:50:10.6532783+00:00",
"suggested_user_id": "497edf82-fd50-44d2-a9b4-4cc068786534",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8659fcac-0fd9-456d-80e4-962d51cc7098",
"db_language_id": "d178205e-47b9-4341-b4fe-7956643f58c7",
"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-06-02T03:50:10.6532783+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3f0c32a-2383-4f26-9a6e-fbd55e709ecb",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "25f91b03-6f31-4436-8096-5314048f93de",
"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": "7c37e482-5d45-4ba8-b0a6-3f12699a4c2c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95647e3d-8b58-4dfd-a435-a0f7cd672636"
},
"suggested_date_start": "2026-06-02T03:50:10.6532783+00:00",
"skill_id": "06b4ffa4-c4fd-44bb-90ec-6298440073e3",
"skill_code": "sample string 32",
"skill": {
"id": "e9a85d21-ea65-409b-b1d1-34813e6caf2c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fc13315c-61fc-4141-b5b3-3e0f252d8657",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c350127-a1bd-4723-b06f-0963156c97c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd339a82-5682-443e-9a1a-9cee541c2cae",
"db_currency_id": "63fd8a58-3bf3-4a2b-94bb-4a52a1d66d1c",
"db_language_id": "8e12ba5c-e702-4f50-a8d5-35e5087e4348",
"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-06-02T03:50:10.6532783+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4c03699b-3b39-4aa6-99b5-f9e463721f1d",
"date_reported_by_company": "2026-06-02T03:50:10.6532783+00:00",
"id2": 36,
"company_id": "409ece7f-072e-4a50-840e-8563d70ec92e",
"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": "9ec3c09a-ab67-4884-9f7f-570316fcc5c4",
"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-06-02T03:50:10.6532783+00:00"
},
"work_instruction_details_id": "d5f4e998-b028-4bf6-8843-ee0c25a9a966",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fa113c42-b591-4a94-ae69-b7e6fa7f670d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9cb7f3ba-1b83-4b98-bddc-1499453055d7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:50:10.6532783+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": "ddf34c5e-952c-47b9-94d3-05437b4ef38b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:50:10.6532783+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.