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": "5a01a5c7-f523-484c-b844-78af7be716e7",
"jobs_id": "e4451c89-081d-4e27-97b9-cfbd3c956fe3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f937e60e-16ea-4145-a852-7a2837988555",
"_parent_id": "29eba9c2-c02c-4b9f-8233-9148841d9c55",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "10090a96-0bcd-4e7a-aba2-ad3fd42c4824",
"project_reference_back_office": "sample string 5",
"project": {
"id": "eeaa88f1-fc60-41f8-b7b3-ebb4591a5440",
"_parent_id": "600fdef1-6b7f-4573-b433-78b8c8b68f38",
"root_parent_id": "58627eb8-7eca-4df0-b5bf-8a337621417a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "92756ea2-23f5-47b3-a69a-ff97a7ee2f8e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "299d4ec0-9698-424b-aba0-1012246fc91a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6eb2b2d0-a292-4920-96b0-5327f7250776",
"_parent_code": "sample string 6",
"sales_organization_id": "ae9781a6-b50c-49da-a08d-c75ec05920d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"modified_dateutc": "2026-11-05T15:18:37.9252099+00:00"
},
"equipment_model_id": "b605f5f5-0662-428c-ab35-47c428685a7b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2aa84fea-c8ea-41da-912d-1e2a411e51e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b4c657e8-5c69-40f8-ab01-39aa4b227e8e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ab7e4c92-beae-4aaa-b8c1-d9a8f95e4724",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22a6efaf-6363-4907-8db2-c6c6813fa8cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00"
},
"equipment_family_id": "a4b776ea-6c1b-4b10-9299-eaf41bc93b7c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "299d4ec0-9698-424b-aba0-1012246fc91a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6eb2b2d0-a292-4920-96b0-5327f7250776",
"_parent_code": "sample string 6",
"sales_organization_id": "ae9781a6-b50c-49da-a08d-c75ec05920d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"modified_dateutc": "2026-11-05T15:18:37.9252099+00:00"
},
"date_in_production_since": "2026-11-05T15:18:37.9351981+00:00",
"date_out_of_production_since": "2026-11-05T15:18:37.9351981+00:00",
"date_end_support": "2026-11-05T15:18:37.9351981+00:00",
"sales_organization_id": "61ec35bc-ac3d-4645-b055-1660536f7d87",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+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-11-05T15:18:37.9351981+00:00"
},
"project_status_id": "976e62a3-6053-4fb5-9ef9-8e131dc8cd28",
"project_status_code": "sample string 10",
"project_status": {
"id": "4fee957b-11c7-4861-addb-56aa15e434b7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fcf4bda8-cdc8-4faf-9ad9-f9fec5920dfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00"
},
"company_id": "f5881403-41f7-4d9e-93b8-5c20db9f21b2",
"company_code": "sample string 12",
"db_address_id": "dda4d2fa-6af2-45df-a417-21e5552455c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d84cfb9e-2ca0-49ca-be2e-f6c274911889",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ffbd7a3c-d32d-4f9b-99e2-1d9de4c4f044",
"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-11-05T15:18:37.9351981+00:00",
"date_create": "2026-11-05T15:18:37.9351981+00:00",
"date_update": "2026-11-05T15:18:37.9351981+00:00",
"updated_by_user_id": "fbd9a738-d48f-48fd-a650-657c195ac5d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-05T15:18:37.9351981+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-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-05T15:18:37.9351981+00:00",
"date_last_job": "2026-11-05T15:18:37.9351981+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-05T15:18:37.9351981+00:00",
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00",
"is_mobile_installation": true
},
"job_type_id": "4b9d7a9f-3958-433b-9dc1-d8a74682ff77",
"job_type_code": "sample string 7",
"job_type": {
"id": "7bbbcbe3-c6f2-40b3-ad5d-7a7b1f2e5d15",
"name": "sample string 2",
"sales_organization_id": "9788bd82-d38b-4441-9927-b1c43b7156e6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00",
"code": "sample string 7"
},
"job_priority_id": "e87e1597-503d-4212-b804-602cbcd8634c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9b5f16ca-b482-4686-b9d8-b771386c6828",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1ec0a65a-df33-42ce-a0cd-235c2ad3cde8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00"
},
"job_status_id": "5413a83e-0493-4000-a1d4-86153b7913a0",
"job_status_code": "sample string 11",
"db_address_id": "1362bc76-3367-4843-ab43-d76501b9c48c",
"contact_id": "d69f78ef-7b61-4657-98cd-88f040b980b0",
"requested_by_company_id": "282ba6f9-dda4-46b3-8698-5e3e013bf20d",
"requested_by_contact_id": "a736f950-84ce-41a9-a613-d0dc611acb1e",
"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-11-05T15:18:37.9351981+00:00",
"due_date": "2026-11-05T15:18:37.9351981+00:00",
"date_create": "2026-11-05T15:18:37.9351981+00:00",
"date_update": "2026-11-05T15:18:37.9351981+00:00",
"date_closed": "2026-11-05T15:18:37.9351981+00:00",
"suggested_user_id": "b796425c-8ae5-4d20-a8ab-89eed626d914",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5abb7a48-578b-4a36-9d14-dd1dd98b9368",
"db_language_id": "e9d67b9a-080f-4a27-825d-cd4d9dec66bc",
"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-11-05T15:18:37.9351981+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0d37d060-dfcd-4f46-bf28-d1e4e71f305d",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc357c23-7aa7-47e6-b79b-07cf365d2549",
"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": "18be8d7c-64d4-4d6d-ad6e-bcd32a007dcd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-05T15:18:37.9351981+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "135c8784-504c-4f2c-9b9f-850a1be53e41"
},
"suggested_date_start": "2026-11-05T15:18:37.9351981+00:00",
"skill_id": "a225a9bd-0cc8-4e78-a684-f1b3777aa44f",
"skill_code": "sample string 32",
"skill": {
"id": "3419ac96-f89e-4b3d-88b4-80ec1efaf3c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c11998a1-55df-4e54-b606-a736f58e0793",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53129786-8cb8-48ba-b1a9-45bce22b0a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "207d13c3-4c2c-4a4d-be43-44d5f8386975",
"db_currency_id": "877d55d9-5c77-4cd2-8e78-9318e7cdd766",
"db_language_id": "5fb4ce43-e6d4-4e04-97c6-f1dcc6e4784c",
"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-11-05T15:18:37.905165+00:00"
},
"modified_dateutc": "2026-11-05T15:18:37.9553154+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f635dc60-9a8b-42df-ad86-25ecfa82cf05",
"date_reported_by_company": "2026-11-05T15:18:37.9553154+00:00",
"id2": 36,
"company_id": "57900f77-775a-4b1e-bd34-251350805916",
"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": "703a4403-17ab-447c-a52e-cf8ad8611496",
"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-11-05T15:18:37.9553154+00:00"
},
"work_instruction_details_id": "f38cb435-bc80-4b0a-8359-c5c99423be17",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "713fc22e-17fe-4d37-bfcb-c9fa348f03c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c0b96ae9-41bc-4d68-8f85-37aec06cb2e2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-05T15:18:37.9553154+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": "cc61186b-0364-467c-a8a9-ad1a23656237",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-05T15:18:37.9553154+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.