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": "b5487011-d6e2-41d3-8193-0e292edf824b",
"jobs_id": "1d7b9076-0933-4312-b904-8660621a4450",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c9226d53-b2a3-423a-b5d4-adfba0d08ce7",
"_parent_id": "64243b90-de10-43f9-8a6e-a6b5099d2902",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eeae2c50-9ffb-4186-9bf2-570e0ba31201",
"project_reference_back_office": "sample string 5",
"project": {
"id": "de4f2de6-3f24-4aca-9b5a-db0e163e3264",
"_parent_id": "ab1073b6-2a1d-4586-a90e-bc96bb08291d",
"root_parent_id": "654af9da-9538-4abc-8407-da5d586b9c73",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b6de5e7a-9e49-4682-9815-c941747ee87f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ea7464ea-bb80-4046-afbf-520c99ded1cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "31e46758-d6ef-4e9a-9f83-1c20a38403ec",
"_parent_code": "sample string 6",
"sales_organization_id": "16435c18-99c8-44ad-b441-1c208f07ec2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"equipment_model_id": "a688ca07-ba85-4542-8715-a9d4f9bf9e2c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "88542a04-0dab-4573-aae0-2f1f6a408a71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7778c837-7ee3-485d-96df-eab19d159231",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "67abd009-6bcc-4f84-b70c-56082dd1acca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a4b6d661-a39d-4c82-91b5-74ec75cd2118",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"equipment_family_id": "287103fc-9c50-4368-adfc-5dcbd34d5949",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ea7464ea-bb80-4046-afbf-520c99ded1cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "31e46758-d6ef-4e9a-9f83-1c20a38403ec",
"_parent_code": "sample string 6",
"sales_organization_id": "16435c18-99c8-44ad-b441-1c208f07ec2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"date_in_production_since": "2026-07-16T08:24:24.7720922+00:00",
"date_out_of_production_since": "2026-07-16T08:24:24.7720922+00:00",
"date_end_support": "2026-07-16T08:24:24.7720922+00:00",
"sales_organization_id": "ada8e331-5af1-446a-9832-38924c882f12",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+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-16T08:24:24.7720922+00:00"
},
"project_status_id": "1172ef07-6d7d-4505-9b1b-ae9f88ecc5f1",
"project_status_code": "sample string 10",
"project_status": {
"id": "3515a818-9b23-4d66-a449-88e95efea44a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0436852-b262-45a8-a4c5-bc96abd4fc91",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"company_id": "20ea4a80-01b7-4fea-a3cb-a122ef4d7779",
"company_code": "sample string 12",
"db_address_id": "7bdd40b7-70d1-45e8-85e6-eb7db21c4a9f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fd19d5ef-5cc9-42c8-8b8a-617aec776156",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e43123e-6818-4abf-9039-27af042aaa87",
"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-16T08:24:24.7720922+00:00",
"date_create": "2026-07-16T08:24:24.7720922+00:00",
"date_update": "2026-07-16T08:24:24.7720922+00:00",
"updated_by_user_id": "c8c1c5bc-49e3-422c-a7fc-eb866bd9c0be",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-16T08:24:24.7720922+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-16T08:24:24.7720922+00:00",
"date_last_job": "2026-07-16T08:24:24.7720922+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-16T08:24:24.7720922+00:00",
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00",
"is_mobile_installation": true
},
"job_type_id": "5f786e60-17d4-4cd4-b32a-2b8fb8018c48",
"job_type_code": "sample string 7",
"job_type": {
"id": "c5697848-c151-4c81-8c62-3aaf3a275c87",
"name": "sample string 2",
"sales_organization_id": "2262797b-9d39-4f3a-875b-b85910d802b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00",
"code": "sample string 7"
},
"job_priority_id": "64cedcb8-a7d9-43b5-bf76-97f5ba9141cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eac816b7-1675-46a6-b940-eca5c9302b8b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "03d37799-6b72-43fc-ba83-b6e997203633",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"job_status_id": "c347d079-4118-4bf2-b46d-9cf7b17d6adf",
"job_status_code": "sample string 11",
"db_address_id": "0cfce4bc-03d0-4fa2-a7ab-667568098371",
"contact_id": "d559d9ab-d97a-461c-9a3d-3d726128575a",
"requested_by_company_id": "1ce0e020-9a5c-4c13-be50-8f338a4af25a",
"requested_by_contact_id": "f47c9d44-a8d4-41f7-8d14-150bd1aa85f4",
"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-16T08:24:24.7720922+00:00",
"due_date": "2026-07-16T08:24:24.7720922+00:00",
"date_create": "2026-07-16T08:24:24.7720922+00:00",
"date_update": "2026-07-16T08:24:24.7720922+00:00",
"date_closed": "2026-07-16T08:24:24.7720922+00:00",
"suggested_user_id": "53054384-c826-4fd8-b9df-dc7f7b029b94",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b40578f9-589b-4390-a6ad-67c99f501860",
"db_language_id": "a334b4ac-1dd0-40de-a626-d8f7ea3e936f",
"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-16T08:24:24.7720922+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "82234bb6-fccc-46ae-b082-f7da9b614127",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9a00309f-2abb-4b8b-b9b1-34b32cc50da6",
"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": "d6b54397-7bce-45ac-9374-2b7b92fb0bcf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1ac1add5-e48c-43ba-816f-f4211dd50d64"
},
"suggested_date_start": "2026-07-16T08:24:24.7720922+00:00",
"skill_id": "78dff492-aeb0-4d3f-88eb-652dc5ca9122",
"skill_code": "sample string 32",
"skill": {
"id": "446b0901-2e95-499f-bae6-b6e6cdd72e6b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9400f6ab-4892-4cbb-977f-c77a49928a6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80ea84e1-aab2-4a81-86c7-2f5631d30fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17bf7dcc-1c5c-4ad4-94db-955b9432be9a",
"db_currency_id": "8a659a7e-0932-4226-84ca-02668b56768e",
"db_language_id": "af0db51d-8e3e-4bc3-981f-325f4fb383b2",
"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-16T08:24:24.7720922+00:00"
},
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "80110804-0982-46a2-bce1-cba52cfe4265",
"date_reported_by_company": "2026-07-16T08:24:24.7720922+00:00",
"id2": 36,
"company_id": "7421bc0c-de65-4848-8277-32cfd9708a02",
"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": "4361547f-69c9-498e-950a-5cd847b3becf",
"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-16T08:24:24.7720922+00:00"
},
"work_instruction_details_id": "2b9222dd-6199-41fa-9231-a97b0389410b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1bff4464-0f5d-4fe4-b2a5-e0905e0c6b3b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c62bf6d9-c910-4ea3-bb2e-83ce60b86e61",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-16T08:24:24.7720922+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": "edc60948-d3d5-417d-84fa-07159ed76cf5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-16T08:24:24.7720922+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.