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": "095e76f0-4438-46b9-9949-69a2b27c974e",
"jobs_id": "dc29b4cb-7ad7-4eb9-bc4d-7a0fe6741618",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c51fbbd-b212-4f00-8a41-727e224be06e",
"_parent_id": "5f0d641c-a4ae-4073-9fee-f891b69327db",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f35f5a40-182b-4bb3-b261-f70446eb9b5f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7f6cad39-5ec4-4736-b4ed-bd497ac62793",
"_parent_id": "900f97a5-89bb-42d9-a86d-990237451677",
"root_parent_id": "1d246adf-0ffc-405c-8416-3c9044c121fa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b0af2d57-e871-4c94-b4c3-0c80bd377fad",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8bdc7fcc-4db7-4865-9356-865ea5894320",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cfc7ad0a-55f4-478a-bbc5-06bac3afa9d6",
"_parent_code": "sample string 6",
"sales_organization_id": "b3e3cb5c-ef67-400e-afde-261a8a060525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"equipment_model_id": "0dbc5684-582e-41e8-94c8-ba6106163370",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "84bb3307-5f76-49a8-9cf0-90694dd77505",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "904db424-0894-48b1-92eb-5ce44efad2bc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8e1042dd-add7-4f8f-bdf4-612702b11fe4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aa013d4b-1ac7-4728-bf8e-bf93167148b7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"equipment_family_id": "8592cb51-42d8-4516-b5ab-71c03a4dec8e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8bdc7fcc-4db7-4865-9356-865ea5894320",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cfc7ad0a-55f4-478a-bbc5-06bac3afa9d6",
"_parent_code": "sample string 6",
"sales_organization_id": "b3e3cb5c-ef67-400e-afde-261a8a060525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"date_in_production_since": "2026-08-11T10:29:13.4104784+00:00",
"date_out_of_production_since": "2026-08-11T10:29:13.4104784+00:00",
"date_end_support": "2026-08-11T10:29:13.4104784+00:00",
"sales_organization_id": "7bce538e-111c-4af9-9881-46b530bd0cb8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+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-08-11T10:29:13.4104784+00:00"
},
"project_status_id": "572dd490-f8b8-437b-98f5-a2da96c328e0",
"project_status_code": "sample string 10",
"project_status": {
"id": "8649e30e-d515-49ed-bbf0-c7eb80795534",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6ab0af1c-95ce-498b-b292-ad09d3a910de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"company_id": "3a377051-d55e-4795-8477-227d6f9fc7c3",
"company_code": "sample string 12",
"db_address_id": "71b405f9-104c-4582-9c23-e3829fbd32a2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "77824fcf-71b4-48c3-b690-78ca56dd67ef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c217c11f-3aad-4773-bb38-6f28d1ed26a8",
"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-08-11T10:29:13.4104784+00:00",
"date_create": "2026-08-11T10:29:13.4104784+00:00",
"date_update": "2026-08-11T10:29:13.4104784+00:00",
"updated_by_user_id": "166d4d86-79b8-4562-ba8a-cdd61e831e3a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-11T10:29:13.4104784+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-08-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-11T10:29:13.4104784+00:00",
"date_last_job": "2026-08-11T10:29:13.4104784+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-11T10:29:13.4104784+00:00",
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00",
"is_mobile_installation": true
},
"job_type_id": "dd45ef33-d9db-45b3-8e9e-3e7259c082df",
"job_type_code": "sample string 7",
"job_type": {
"id": "74dee331-097f-4ec5-9b7a-dbfeda2af19d",
"name": "sample string 2",
"sales_organization_id": "4c32c90d-e4f3-4f38-91f2-1c6f1ce4ca9d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00",
"code": "sample string 7"
},
"job_priority_id": "14b9690f-0665-4ebe-8ffb-ac196485db9d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "56e18143-ee52-4c39-8a2c-6c66f9706b21",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "947e3f0a-cfdd-4ebe-9eda-6b410e50e464",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"job_status_id": "bd4a98d8-762e-4737-af96-e03b8ff2b409",
"job_status_code": "sample string 11",
"db_address_id": "239ade08-c935-4c8b-a85f-0bc234032b27",
"contact_id": "0b31f827-82e6-43d0-9aed-50f9d0a1c2e7",
"requested_by_company_id": "76c311c6-091c-40c2-82b3-816333758922",
"requested_by_contact_id": "4123b165-90e7-4db0-a376-e5ab3134ca9a",
"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-08-11T10:29:13.4104784+00:00",
"due_date": "2026-08-11T10:29:13.4104784+00:00",
"date_create": "2026-08-11T10:29:13.4104784+00:00",
"date_update": "2026-08-11T10:29:13.4104784+00:00",
"date_closed": "2026-08-11T10:29:13.4104784+00:00",
"suggested_user_id": "e68aaf9f-dfa8-4453-a72b-c2e9df4e1e69",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16ab5a04-9ca4-4d8f-990e-50cfdb5ac381",
"db_language_id": "88ad64bc-ac6e-4dd5-9932-a2223bf9a855",
"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-08-11T10:29:13.4104784+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f8376eaf-5272-428e-b41b-e950857a09ab",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8aae7c16-557f-4de5-8c11-674bc6940651",
"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": "f02f7c99-7e21-4220-a2bd-d7c40d9e4303",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "29688bcc-5f99-4e97-aa35-77b0427b6aaa"
},
"suggested_date_start": "2026-08-11T10:29:13.4104784+00:00",
"skill_id": "98ad4333-614a-47c6-a04b-85cc6a86bafe",
"skill_code": "sample string 32",
"skill": {
"id": "98a2f63f-ce39-49f2-8c48-dac5c22f9066",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ec06808d-4e48-41d3-b307-4c61df0d08e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "335dbf25-9401-42b9-aa64-b97020533aaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b51f5a1-a7fc-44ec-bf8a-b72cea64b28b",
"db_currency_id": "c1678563-6b94-4d10-b194-f98c2d566729",
"db_language_id": "b982f116-0dcb-4b1f-a17b-82c4a07c1052",
"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-08-11T10:29:13.4104784+00:00"
},
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6819f019-954d-4547-8eb4-ac045e053a85",
"date_reported_by_company": "2026-08-11T10:29:13.4104784+00:00",
"id2": 36,
"company_id": "8a73c2c5-55bd-47c2-a8c4-4cfc667831c0",
"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": "1615d818-5e0b-4510-85aa-028995981653",
"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-08-11T10:29:13.4104784+00:00"
},
"work_instruction_details_id": "d9440458-a229-47ff-998f-f54c598df87c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b44a1ec2-2423-42d5-9eca-e17fae8784bd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e4b13fd0-2838-4c8b-aee5-65e76978c579",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-11T10:29:13.4104784+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": "bbee81d3-39fe-4b68-9cac-d7243359a86e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-11T10:29:13.4104784+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.