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": "bac76ce7-8f04-43e9-9452-a0fefd044373",
"jobs_id": "d95e0808-ffbe-4f84-9552-5ed46e98f234",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d682c9b9-2e84-4969-973e-0153e55e86ab",
"_parent_id": "b2090618-0dc4-4cdb-96d1-33a61305ae3c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3c7b2083-52a6-4524-8762-23e145890427",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c09ee81e-1047-4776-90be-005c7e00e918",
"_parent_id": "f9458962-bd60-4af0-8590-82939bff940f",
"root_parent_id": "fef3e043-f2da-4293-97e9-2bafb6298c85",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5cbda5dc-0517-4abd-a150-882fe527ada1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2c32a524-699c-4c27-91ed-eac3dbedf911",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc449a78-ea30-4747-8208-023577154c74",
"_parent_code": "sample string 6",
"sales_organization_id": "3007e836-c9da-42b8-a745-5d821de8f33a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"equipment_model_id": "94540378-12ef-4fd7-858c-215f8925c3ba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7005124e-fa0a-47e8-99cd-9b5f9b35ff8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6eeb9f7b-5674-499f-9cc3-e3aad5eaa6cf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9aa80ca1-ac6a-4866-90ef-d26255a34272",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e0c52c92-afe8-49cb-a935-4810a022ecfa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"equipment_family_id": "61875ffc-dee8-4cea-b881-1c8c34521b98",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2c32a524-699c-4c27-91ed-eac3dbedf911",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc449a78-ea30-4747-8208-023577154c74",
"_parent_code": "sample string 6",
"sales_organization_id": "3007e836-c9da-42b8-a745-5d821de8f33a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"date_in_production_since": "2026-07-24T04:08:32.2518785+00:00",
"date_out_of_production_since": "2026-07-24T04:08:32.2518785+00:00",
"date_end_support": "2026-07-24T04:08:32.2518785+00:00",
"sales_organization_id": "813f77d9-d934-413d-9014-a7994b1d75ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+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-24T04:08:32.2518785+00:00"
},
"project_status_id": "17a99241-378f-4b41-a531-63fbcbeedac2",
"project_status_code": "sample string 10",
"project_status": {
"id": "8facfe78-e344-4404-959c-76d582ef9140",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ae35633d-483a-418c-b0f4-b2c4c8e19420",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"company_id": "c14a159e-d7b7-47a7-bb1a-3618311dbfae",
"company_code": "sample string 12",
"db_address_id": "6a1b5412-3816-406b-860f-ab7dd89c199e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5c776c4f-3dcf-43a9-830c-78325e850815",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "946af859-68ab-49cd-a27d-3a9acf1dccd2",
"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-24T04:08:32.2518785+00:00",
"date_create": "2026-07-24T04:08:32.2518785+00:00",
"date_update": "2026-07-24T04:08:32.2518785+00:00",
"updated_by_user_id": "562e7878-1746-403c-bf77-a8c4a43ae62c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T04:08:32.2518785+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T04:08:32.2518785+00:00",
"date_last_job": "2026-07-24T04:08:32.2518785+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T04:08:32.2518785+00:00",
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00",
"is_mobile_installation": true
},
"job_type_id": "1fa6ba48-7b42-4a61-a9cb-d2d4a31f7431",
"job_type_code": "sample string 7",
"job_type": {
"id": "66ec78b6-1005-43c3-97d7-6a91e696e4e9",
"name": "sample string 2",
"sales_organization_id": "07070d2c-5b44-487a-9a0c-f7b66f4a0b45",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00",
"code": "sample string 7"
},
"job_priority_id": "b21958a3-8379-4aa3-bc54-246bd9d4358e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "39432dc9-7582-45cd-b6f7-40d6c269ac68",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "979a5fc0-d5c5-47c9-94e8-5efe1608911c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"job_status_id": "fc47cc08-0989-4a0d-acc2-285ebba33af3",
"job_status_code": "sample string 11",
"db_address_id": "530a9d91-4e63-473e-bb13-2a256f4c6c7b",
"contact_id": "45541d64-49aa-4caf-bc59-690c59e546a0",
"requested_by_company_id": "0d62a8e3-6459-4d3b-a93a-c1c93a1707c3",
"requested_by_contact_id": "03ea75a2-52f4-4bc5-896d-d68d64a39bf6",
"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-24T04:08:32.2518785+00:00",
"due_date": "2026-07-24T04:08:32.2518785+00:00",
"date_create": "2026-07-24T04:08:32.2518785+00:00",
"date_update": "2026-07-24T04:08:32.2518785+00:00",
"date_closed": "2026-07-24T04:08:32.2518785+00:00",
"suggested_user_id": "67b65779-4885-4e39-8497-b4ef87c51340",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f17dcbe6-7229-489b-9457-650597819b48",
"db_language_id": "73c2f24a-32ec-4a6d-9ba5-e7d2a530ccdc",
"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-24T04:08:32.2518785+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "73a272f6-5665-4397-902e-3503b02a1f50",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "70f3d98e-bdc2-4c5e-a758-a006b5eafe40",
"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": "289782b1-afd9-4127-a00f-aacddc7c5756",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "30332005-dd3c-4dd5-a9cc-de3ba78fd436"
},
"suggested_date_start": "2026-07-24T04:08:32.2518785+00:00",
"skill_id": "fcaca866-e451-4e0c-affc-53394607fe48",
"skill_code": "sample string 32",
"skill": {
"id": "f18322f1-2e91-489a-a6d8-807b605b34c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c52d22dd-a352-435a-995f-59b9f2887865",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01355d79-e23f-4a53-8748-0a683a63bfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba76471-5c0e-4c95-aad3-cd6c876e052a",
"db_currency_id": "c0fd8fe1-7af7-42b4-ac12-238dbdb1d2ef",
"db_language_id": "c1884e4d-ca09-41bd-a37d-e406e007aab8",
"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-24T04:08:32.2362528+00:00"
},
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "627a9af7-448a-4d12-9c3a-af0d36d0ccac",
"date_reported_by_company": "2026-07-24T04:08:32.2518785+00:00",
"id2": 36,
"company_id": "6988c9ce-063f-46bc-abf1-a4e9b4900c7f",
"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": "37261d7d-ea1f-4883-bff1-051e04c397cd",
"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-24T04:08:32.2518785+00:00"
},
"work_instruction_details_id": "45b335cc-0d58-49d3-8b46-2822387773c8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2cc54d8b-4b81-4a1e-95b0-f76795f48a34",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1d2da3e5-d357-42f1-8b30-38b31da5edcf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T04:08:32.2518785+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": "5c1c9d4f-b257-45dd-ab2d-33b1273d4d81",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T04:08:32.2518785+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.