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": "bf23ea0d-98ad-4875-9aba-e0ae2c9868a4",
"jobs_id": "d0498bd8-3d84-4168-81bc-2e81619c2b8e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "62f7ed72-83e9-4e46-a53c-78e79423b8f9",
"_parent_id": "bef5c731-a0a0-4811-9e88-5be097b4d0b9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "46340af3-41b6-4d25-8449-12f215ecd0d2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "df501acb-7f36-417e-b417-632ddefef130",
"_parent_id": "75b47c25-95ec-4ed0-a1d8-d52ca819ce5d",
"root_parent_id": "4696843c-b963-4a0c-97e0-eb154a2cd6f4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "be94a243-52ae-4786-96df-945b6ba727eb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ec3a20b1-b29b-4b21-ad92-b993b6cb3e26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "457c0b2d-c4a2-4ed9-9768-306699768463",
"_parent_code": "sample string 6",
"sales_organization_id": "63ae507b-4907-4961-b9a1-bbc47f7e8697",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"equipment_model_id": "20768564-49dc-4569-81a2-151753cc4646",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "264a06c6-d0c3-437a-b5d2-40322139fe19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "83a8d64c-e69a-4efd-b661-b7a1b5ff4bbd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "95993a1e-911c-4930-9dbf-2e06149ffbd9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "73a83675-a810-40e2-9c01-e8907664b1fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"equipment_family_id": "16ae3638-8d1e-43da-9788-24110eb247d4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ec3a20b1-b29b-4b21-ad92-b993b6cb3e26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "457c0b2d-c4a2-4ed9-9768-306699768463",
"_parent_code": "sample string 6",
"sales_organization_id": "63ae507b-4907-4961-b9a1-bbc47f7e8697",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"date_in_production_since": "2025-10-07T13:52:51.5414177+00:00",
"date_out_of_production_since": "2025-10-07T13:52:51.5414177+00:00",
"date_end_support": "2025-10-07T13:52:51.5414177+00:00",
"sales_organization_id": "ed5a152a-058b-42cd-93fb-90161b18de78",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+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": "2025-10-07T13:52:51.5414177+00:00"
},
"project_status_id": "4af3b22d-c9a8-483d-904f-e137c323647f",
"project_status_code": "sample string 10",
"project_status": {
"id": "d73b7e35-e95b-4d7b-a1d9-0cc341133ac8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "610b2ad5-8551-48fe-a66b-1086a64342ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"company_id": "c25f9c90-0b22-458f-9672-a1b6c95397b7",
"company_code": "sample string 12",
"db_address_id": "0238013a-62bc-471c-9bfa-cb532ed221a8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41204584-c888-4672-8a37-666c4d3cd3e1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f9a12efd-ed2f-4b94-8e7e-3a27b65fa716",
"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": "2025-10-07T13:52:51.5414177+00:00",
"date_create": "2025-10-07T13:52:51.5414177+00:00",
"date_update": "2025-10-07T13:52:51.5414177+00:00",
"updated_by_user_id": "9c2b0bf2-68e6-4853-a3d6-643874fec67f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-07T13:52:51.5414177+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": "2025-10-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-07T13:52:51.5414177+00:00",
"date_last_job": "2025-10-07T13:52:51.5414177+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-07T13:52:51.5414177+00:00",
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00",
"is_mobile_installation": true
},
"job_type_id": "4a2cf44f-f946-4ad1-a49d-6edd04864869",
"job_type_code": "sample string 7",
"job_type": {
"id": "3e537228-1c3f-44a6-904b-1e514e75f66b",
"name": "sample string 2",
"sales_organization_id": "0e4cdb92-1e70-44ff-a4d1-55939750316e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00",
"code": "sample string 7"
},
"job_priority_id": "18cfe5d9-ce40-4753-ab4b-357456ccc735",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0f48a7f7-3470-4e6a-9d20-262be25bc20c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d94cf8de-7961-428c-a08d-77a0ec6b204c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"job_status_id": "b56ba577-1f96-4ea4-afda-a8975f9051a4",
"job_status_code": "sample string 11",
"db_address_id": "cb80337f-1142-4f76-b4e9-ad71325ce7c4",
"contact_id": "a1f0bb40-184f-42a5-9ab7-7a61f62f00ac",
"requested_by_company_id": "b1036c45-6e96-4aa7-99da-5d312fd8bda2",
"requested_by_contact_id": "ee718d7c-b831-48b6-bb63-65d2e50a40a2",
"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": "2025-10-07T13:52:51.5414177+00:00",
"due_date": "2025-10-07T13:52:51.5414177+00:00",
"date_create": "2025-10-07T13:52:51.5414177+00:00",
"date_update": "2025-10-07T13:52:51.5414177+00:00",
"date_closed": "2025-10-07T13:52:51.5414177+00:00",
"suggested_user_id": "17c37226-df6a-445d-b19b-8d03932729f6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3b4af10f-0581-4181-b8af-dcb22ef24364",
"db_language_id": "c7a057fc-19f0-47eb-b8c6-92c0e6139e02",
"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": "2025-10-07T13:52:51.5414177+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4123994f-f939-48f4-b371-82ed3433aae9",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e13ba8ef-5bda-4b2d-a467-d37833103729",
"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": "6a953d97-801e-4521-ad91-1ac6279cd2cd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3b26862c-a976-447d-ad03-7f81748c3b9e"
},
"suggested_date_start": "2025-10-07T13:52:51.5414177+00:00",
"skill_id": "0c801b3b-fd62-444f-a1a0-73e2b3a2fbf5",
"skill_code": "sample string 32",
"skill": {
"id": "a7f176d2-0b42-4cfc-9900-e3367aec3250",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4688f3b-68b4-423a-87e2-9dc0ebb4a51a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aa42932-f70f-4a29-b272-aaaa122d7e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96d787c0-e1ff-4121-bea2-1671e87da0d3",
"db_currency_id": "8e9951ef-3390-42be-8ec1-044889e0366d",
"db_language_id": "18a9b71b-31c0-4432-9d2a-8304e693f34a",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "05c5be33-7f83-4fbe-b37a-32c460a2b0ec",
"date_reported_by_company": "2025-10-07T13:52:51.5414177+00:00",
"id2": 36,
"company_id": "5f7e190d-194a-4995-825d-5cfd0efdb248",
"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": "950e17e4-a7c9-4366-a46a-82f81ea72b8f",
"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": "2025-10-07T13:52:51.5414177+00:00"
},
"work_instruction_details_id": "179c0649-9a72-4fca-aed8-7958003ab9b3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2fb93573-a072-4e72-a96c-1279ac277c33",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02dada1c-a921-421a-81e7-05c76b374668",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-07T13:52:51.5414177+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": "eedb322d-7461-4a08-8f7a-eca103ec0c71",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-07T13:52:51.5414177+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.