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": "9f241906-8991-433c-bcc2-818bec61fcca",
"jobs_id": "b7b6c46f-e3d5-4181-8580-1664121f6c32",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1c13977d-a3fb-423b-84e8-1eb46d7df9e6",
"_parent_id": "24c455f0-be75-44ff-8b45-9c69a6324fae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c8c08c9f-5229-434c-ac5a-a1d314e050ee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "557fab04-91ed-485f-bf20-e82edd0ff39b",
"_parent_id": "8a2b2ecc-b7ae-42ef-af52-eaaa41cd7814",
"root_parent_id": "fa8853db-1782-4434-a415-8786ebe7ffda",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d404a7f8-bf07-4480-b11f-4fa1b8d65558",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "00349679-ff6b-432c-940d-effe467ebd0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "783c09c9-69f8-4f25-83f8-0404ad742d91",
"_parent_code": "sample string 6",
"sales_organization_id": "bcae2817-dacc-4104-8018-8e7ff6dd0efc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"equipment_model_id": "1d191e0f-8c9b-4d99-acaf-eed6536e9bda",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "382fb5a2-117c-4af1-b6e4-43300e1363d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ecb96eee-185e-4429-a5da-19c478ad5f5c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eb8f3222-cf1f-4fe7-90c5-33b7b72db9ea",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f4d1d3eb-81e2-47ee-ae0d-39d855dd6f56",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"equipment_family_id": "0cd59177-44ff-4868-aad2-885f5cf64aaa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "00349679-ff6b-432c-940d-effe467ebd0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "783c09c9-69f8-4f25-83f8-0404ad742d91",
"_parent_code": "sample string 6",
"sales_organization_id": "bcae2817-dacc-4104-8018-8e7ff6dd0efc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"date_in_production_since": "2026-07-02T20:58:05.4835667+00:00",
"date_out_of_production_since": "2026-07-02T20:58:05.4835667+00:00",
"date_end_support": "2026-07-02T20:58:05.4835667+00:00",
"sales_organization_id": "771cbe85-2676-42ff-8313-f9bd1e3a119f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+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-07-02T20:58:05.4835667+00:00"
},
"project_status_id": "3d65e1e9-0ebc-4827-af47-d45cc7c9efdd",
"project_status_code": "sample string 10",
"project_status": {
"id": "d01c591f-3234-4d45-8393-13f0f0ec95d1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c3061f11-e5d1-4def-b24c-6f2277a2f1dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"company_id": "694a3c7f-e030-438e-8949-ae12d0bc60f7",
"company_code": "sample string 12",
"db_address_id": "76a69575-8f5e-42ae-a576-105666df7442",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "958850c2-2f73-4acb-bb67-3d0784f66fa7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "709762ad-f67d-4b4d-b78b-6f090a6621e9",
"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-07-02T20:58:05.4835667+00:00",
"date_create": "2026-07-02T20:58:05.4835667+00:00",
"date_update": "2026-07-02T20:58:05.4835667+00:00",
"updated_by_user_id": "8c5a28e6-32ee-4497-a426-d7d91aee573b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-02T20:58:05.4835667+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-07-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-02T20:58:05.4835667+00:00",
"date_last_job": "2026-07-02T20:58:05.4835667+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-02T20:58:05.4835667+00:00",
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00",
"is_mobile_installation": true
},
"job_type_id": "abd079f9-e378-4f7f-a05a-a68d84e4df5d",
"job_type_code": "sample string 7",
"job_type": {
"id": "8d62ca60-9e8f-4a4b-a2ad-632fc1b65410",
"name": "sample string 2",
"sales_organization_id": "bc61b036-9d78-4a23-a984-d2e2d63c3224",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00",
"code": "sample string 7"
},
"job_priority_id": "41837d8a-bdc9-4e34-b55a-38992b1c2b10",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d2b14448-a767-4307-bc80-5bdc91f84e0c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "64cc8578-e303-471b-b440-5a09c83ff54d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"job_status_id": "d2ee2ea4-dda8-4faa-b810-77ddd1bc4a74",
"job_status_code": "sample string 11",
"db_address_id": "b8f406eb-cee3-4824-a6c7-d396ba65b1a8",
"contact_id": "c1beb242-714d-472d-b1cf-d8d7c27e9ece",
"requested_by_company_id": "f69db197-95be-4d63-874f-487372c44bc1",
"requested_by_contact_id": "9b7dd50b-78dc-4db2-8491-0f08a0873314",
"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-07-02T20:58:05.4835667+00:00",
"due_date": "2026-07-02T20:58:05.4835667+00:00",
"date_create": "2026-07-02T20:58:05.4835667+00:00",
"date_update": "2026-07-02T20:58:05.4835667+00:00",
"date_closed": "2026-07-02T20:58:05.4835667+00:00",
"suggested_user_id": "2d3591c7-3002-4a44-8a0a-28e697110bce",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7c7bc85a-6372-4740-b211-bfc4cce94897",
"db_language_id": "15e784bf-3c42-45b9-b95f-fdee75d495d3",
"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-07-02T20:58:05.4835667+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bf3cce5d-1629-4318-b569-3a64d39cb0b7",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ecb450e6-cfab-4404-95b9-0f0c41ca49f3",
"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": "80012783-009f-479c-9ff5-619f7b30b6c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1f72e7ea-562a-40e2-a83e-572df240f0e2"
},
"suggested_date_start": "2026-07-02T20:58:05.4835667+00:00",
"skill_id": "117e61f6-9bc8-4340-bf80-583152ca6cfe",
"skill_code": "sample string 32",
"skill": {
"id": "420613c3-9f62-41b6-823b-bcc76a5fb23f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3818f011-c886-4fb5-9a81-ec1f9951aed5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ef63d92-0dfb-46a3-aaf4-70f367429773",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f680b6e-f277-4837-bdb8-2fad483f6b4c",
"db_currency_id": "391d4c06-fc37-4eaf-9966-ab8f10ca084d",
"db_language_id": "4491ff13-1758-4c08-8993-7153d8b98c3a",
"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-07-02T20:58:05.4835667+00:00"
},
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1fc585e8-a675-4634-b886-3394ebe3fd94",
"date_reported_by_company": "2026-07-02T20:58:05.4835667+00:00",
"id2": 36,
"company_id": "d6b4b101-53b2-48c2-a122-db460e8d81d5",
"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": "45c38a2d-0dec-412b-bbb2-a6ac1cc844ca",
"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-07-02T20:58:05.4835667+00:00"
},
"work_instruction_details_id": "54ac531f-ab2e-4ca6-adc3-25db626c738d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a547720f-09c6-48c9-92d8-fe5119cbd8d4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "30b25b2f-3653-41c2-a2cc-d6689b9bca17",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-02T20:58:05.4835667+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": "9f896b75-6136-4453-85a5-f179903545c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-02T20:58:05.4835667+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.