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": "795ce146-9170-41df-99d0-fe56c13614c8",
"jobs_id": "50c62e34-800b-4411-b4ea-cc3a0520f9b6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ac5f4613-871c-4152-a72e-7584fa46d45c",
"_parent_id": "2eb82cb8-31bb-4130-9b0f-60b0e251671c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f4d39387-634d-47b9-a96c-082b95429a96",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cca69129-e4df-4f63-9054-758b5466161c",
"_parent_id": "e8f4997a-b14d-4485-bb79-c4a95840c9ea",
"root_parent_id": "d3dc4b1a-68c5-44a6-8f9b-36d046dd9b1e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "93a250ae-ee33-466a-bc7a-79061f34ff3c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3704b6f7-f803-4ff2-955c-40f494ebee7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1d29ba7-cbe9-40f7-a08b-6271a7e4c7e2",
"_parent_code": "sample string 6",
"sales_organization_id": "151c398f-7745-4cbb-85c7-4da8898a8c51",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"modified_dateutc": "2026-10-30T08:41:04.1570876+00:00"
},
"equipment_model_id": "850a040c-02b9-4886-9654-0075e59b5153",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "04631fcf-edf6-49b4-8fa1-af212df2ff20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "18efa6a5-5991-4bb3-8642-81b86d2098fa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "312dabb2-863d-4bab-b82b-6b768f044465",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca1700ed-3a16-4c76-9d36-7f44ea0a7c30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"modified_dateutc": "2026-10-30T08:41:04.1570876+00:00"
},
"equipment_family_id": "0b7aabf3-3cb3-4aec-99b0-2f9f0c46a73c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3704b6f7-f803-4ff2-955c-40f494ebee7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1d29ba7-cbe9-40f7-a08b-6271a7e4c7e2",
"_parent_code": "sample string 6",
"sales_organization_id": "151c398f-7745-4cbb-85c7-4da8898a8c51",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"modified_dateutc": "2026-10-30T08:41:04.1570876+00:00"
},
"date_in_production_since": "2026-10-30T08:41:04.1570876+00:00",
"date_out_of_production_since": "2026-10-30T08:41:04.1570876+00:00",
"date_end_support": "2026-10-30T08:41:04.1570876+00:00",
"sales_organization_id": "6a784501-af2d-481f-a9f8-aa46d05fd7b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+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-10-30T08:41:04.1727851+00:00"
},
"project_status_id": "a715c8a1-f39b-487d-8320-760184096ade",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd977ef1-47de-40ca-9f4c-f7347f02fa71",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "21e6c47e-7b0b-44ec-93e6-f22033b1e2e0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00"
},
"company_id": "45c3c99b-c51f-4ddc-8ebf-98f09d82e570",
"company_code": "sample string 12",
"db_address_id": "ae1a2aa7-a903-4488-b7f5-9929d5ca6497",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f192f1de-c43a-494f-b243-b440ed5942a4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2c8937ac-3d80-4617-afe9-ace873bf7823",
"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-10-30T08:41:04.1727851+00:00",
"date_create": "2026-10-30T08:41:04.1727851+00:00",
"date_update": "2026-10-30T08:41:04.1727851+00:00",
"updated_by_user_id": "a9bb4c91-54e6-47e0-8a6f-e97afe7be18e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-30T08:41:04.1727851+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-10-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-30T08:41:04.1727851+00:00",
"date_last_job": "2026-10-30T08:41:04.1727851+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-30T08:41:04.1727851+00:00",
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00",
"is_mobile_installation": true
},
"job_type_id": "e94814dc-2bbb-4c2b-802f-c50a55491411",
"job_type_code": "sample string 7",
"job_type": {
"id": "acfd4398-2fc2-4919-b40e-b1bcc04daff1",
"name": "sample string 2",
"sales_organization_id": "2abf7884-d9ad-4d65-90cb-7f6a363b8c70",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00",
"code": "sample string 7"
},
"job_priority_id": "f369f47e-13a8-4a22-ad36-418069c0e125",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7f35e980-88ae-475b-95c5-0614ea80654a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e967050a-1490-45c0-844c-b7d6a1c51e25",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00"
},
"job_status_id": "175090cc-1d44-443c-aa84-67b1d1d3d07f",
"job_status_code": "sample string 11",
"db_address_id": "d11fdb88-7aa3-454e-80af-171681de16b6",
"contact_id": "8fc42257-fc7e-4399-b891-547b9927c17b",
"requested_by_company_id": "f11f8d9c-31ca-4bfe-b5fc-e8c73b972923",
"requested_by_contact_id": "af5ff6ec-8b43-4f95-9cdb-9d744e39642a",
"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-10-30T08:41:04.1727851+00:00",
"due_date": "2026-10-30T08:41:04.1727851+00:00",
"date_create": "2026-10-30T08:41:04.1727851+00:00",
"date_update": "2026-10-30T08:41:04.1727851+00:00",
"date_closed": "2026-10-30T08:41:04.1727851+00:00",
"suggested_user_id": "f0341201-4ccb-499f-9e2d-30cb8546e495",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "52b03d9b-76b6-4733-a1d6-154d6223e87b",
"db_language_id": "f7d5c8a6-49c7-40c7-a16c-aa1f23426728",
"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-10-30T08:41:04.1727851+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9b9ec60-232a-41bb-b7f9-e7839761a909",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d2d3c840-5fd3-441a-ae33-0ad987e25e70",
"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": "b9b2c184-df16-4df9-8d9b-1de92978f587",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d73c334c-8475-4e50-9915-8b82eb4c4938"
},
"suggested_date_start": "2026-10-30T08:41:04.1727851+00:00",
"skill_id": "40465cd9-446a-4341-805c-dc34ffa95c4f",
"skill_code": "sample string 32",
"skill": {
"id": "e1bc2754-4ce0-4275-901c-c32a6683fb52",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3be3eece-7434-4fd3-b093-0d62a3e663e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f6050dae-71f9-49ab-89c0-c02ab33cf731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eeab7511-2731-4e6e-9b3c-77c119d45848",
"db_currency_id": "93c82fc3-cafc-4c06-90e0-3f8685f82a72",
"db_language_id": "b0b0fce1-20fc-40be-97e8-f3187f75547e",
"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-10-30T08:41:04.1570876+00:00"
},
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a8151936-16c8-4507-ade0-5afd3540c5f8",
"date_reported_by_company": "2026-10-30T08:41:04.1727851+00:00",
"id2": 36,
"company_id": "d3258a0f-f435-4184-a2b8-01664bed5502",
"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": "6d220c01-ebcd-463f-8fa2-4cbe1f535311",
"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-10-30T08:41:04.1727851+00:00"
},
"work_instruction_details_id": "be1b15ee-132f-44c7-960c-0a6c75f6fc94",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dcc695ec-aa0c-4c0e-881c-ada875323888",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d294834f-2a96-497d-825c-fcca48aa9123",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-30T08:41:04.1727851+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": "f42b7ff6-120b-484e-898a-5f13f46ea3d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-30T08:41:04.1727851+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.