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": "38d63eaa-53e2-476f-a26c-7696bfdc956e",
"jobs_id": "9320ccfd-107b-4c4e-b2d2-4afa8a6ea338",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bf3e9c33-1a2b-4b7d-a07f-f234111ea10c",
"_parent_id": "8f3333d3-6e55-4995-ab24-9de771c7b0bf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "be36d8f5-bdda-4fd8-bedd-097683843a88",
"project_reference_back_office": "sample string 5",
"project": {
"id": "46b943fe-85f7-4a8f-81ed-50aaa87fc8cf",
"_parent_id": "2200ce87-3aeb-4074-95f2-1e10270b1bc4",
"root_parent_id": "f88b6611-90a4-4aec-9fee-19aeb8016fd0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "197d6e9a-c983-4e2e-ab0f-675a37876e17",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ee0483c-bef2-48f0-bea6-633cea3d83f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e1a7fe6-d869-4bac-a7ac-a9c053ecccad",
"_parent_code": "sample string 6",
"sales_organization_id": "c734dd04-e84d-4320-9e89-54ae1afe164b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"modified_dateutc": "2026-07-18T01:57:03.2122108+00:00"
},
"equipment_model_id": "72a7c1f5-f357-4302-b298-f8112849fecb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ec58966b-dbcd-4f4c-abd9-b2c3d9da49fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "839e635c-5524-4ff5-8a18-af2fabeeaefb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "81b56849-c253-4780-8cdc-71489300b66b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "28d9aed7-cd67-4c1a-8aaa-b0737b6c4728",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"modified_dateutc": "2026-07-18T01:57:03.2122108+00:00"
},
"equipment_family_id": "431142f6-f748-4121-9d79-98440b61e153",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ee0483c-bef2-48f0-bea6-633cea3d83f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e1a7fe6-d869-4bac-a7ac-a9c053ecccad",
"_parent_code": "sample string 6",
"sales_organization_id": "c734dd04-e84d-4320-9e89-54ae1afe164b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"modified_dateutc": "2026-07-18T01:57:03.2122108+00:00"
},
"date_in_production_since": "2026-07-18T01:57:03.2122108+00:00",
"date_out_of_production_since": "2026-07-18T01:57:03.2122108+00:00",
"date_end_support": "2026-07-18T01:57:03.2122108+00:00",
"sales_organization_id": "9d7e49d4-5d43-47a5-80db-770d47bc2b6a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+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-18T01:57:03.2122108+00:00"
},
"project_status_id": "eaa066eb-a472-42e1-a35c-99fff897fe2d",
"project_status_code": "sample string 10",
"project_status": {
"id": "cebbb01b-75e7-48c0-98aa-02ca458a7cee",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cbaf7ada-b9c5-4511-8986-1f9d3f60d229",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T01:57:03.2122108+00:00"
},
"company_id": "c747b632-7d9b-42ee-93ec-38783da77877",
"company_code": "sample string 12",
"db_address_id": "970c3bc1-2a81-463e-afd2-c4139448bff3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4e03ff30-df1b-4cb3-9661-83a2227ccab0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "de443064-9fb1-4304-ae36-b2d6bfa3bb52",
"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-18T01:57:03.2122108+00:00",
"date_create": "2026-07-18T01:57:03.2122108+00:00",
"date_update": "2026-07-18T01:57:03.2122108+00:00",
"updated_by_user_id": "cf11ae69-a537-4c21-8981-ab1e4458ccba",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-18T01:57:03.2122108+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-18T01:57:03.2278346+00:00",
"date_last_job": "2026-07-18T01:57:03.2278346+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-18T01:57:03.2278346+00:00",
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00",
"is_mobile_installation": true
},
"job_type_id": "d8f7b89a-3c62-4dd5-b7e9-0f2056cad554",
"job_type_code": "sample string 7",
"job_type": {
"id": "ee4c2811-fbe1-4366-b6b3-7a0f917bf015",
"name": "sample string 2",
"sales_organization_id": "a6f96802-acba-43fb-86e8-95eb33622df4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00",
"code": "sample string 7"
},
"job_priority_id": "2587a013-fae4-4ad1-8e7b-4bbfff28d0dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c4eb9fff-0f2f-4e62-a745-6d98ce28d63c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ceb574dd-ae8b-4437-95c1-d86cbdd1d5ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00"
},
"job_status_id": "9f52c67e-bc9d-4b68-9d2c-74993f838de6",
"job_status_code": "sample string 11",
"db_address_id": "77e6309a-af04-47ed-825d-15ff48d1ff7d",
"contact_id": "f9b03a96-1022-44e2-b035-0a3f8e1d3024",
"requested_by_company_id": "6832b330-7a24-4eb5-95b3-fc33f86d155f",
"requested_by_contact_id": "72568be9-b0c8-474d-89d6-9b764920b670",
"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-18T01:57:03.2278346+00:00",
"due_date": "2026-07-18T01:57:03.2278346+00:00",
"date_create": "2026-07-18T01:57:03.2278346+00:00",
"date_update": "2026-07-18T01:57:03.2278346+00:00",
"date_closed": "2026-07-18T01:57:03.2278346+00:00",
"suggested_user_id": "ffc52b1a-c18a-4fd1-9372-aac90766f1cc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d54d9527-74ce-4860-92e4-2b0eeb136439",
"db_language_id": "3e1f25a4-0f4a-41e7-afcc-6ae3b6f50c37",
"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-18T01:57:03.2278346+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5f1c1995-26f3-40c3-b8a4-c275d060edc4",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "47a08bcb-4973-4d0a-bd55-96c02ae0ad11",
"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": "815ca04c-811f-43e9-b394-297b30a3f41a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "54c6d12a-08b6-40fc-8588-e0592f42f35c"
},
"suggested_date_start": "2026-07-18T01:57:03.2278346+00:00",
"skill_id": "323d47f3-e8d2-4011-845b-0a201d4d1eab",
"skill_code": "sample string 32",
"skill": {
"id": "ffac7b3e-c8f1-457b-9175-31c65e96aab5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d5e09a43-c9aa-4e26-b476-199a750c3f86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d1fb219-6375-4e3c-beb5-9637f7ecf7bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05771c52-27e8-4fe7-ab2c-8727841ef9c6",
"db_currency_id": "b2c587b5-4760-4dd2-9844-b404f0919880",
"db_language_id": "04ea9c56-8361-40e1-ae1d-51a6ec431be7",
"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-18T01:57:03.2122108+00:00"
},
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3a55a468-43c7-4481-b475-2c04c8a0a7a6",
"date_reported_by_company": "2026-07-18T01:57:03.2278346+00:00",
"id2": 36,
"company_id": "55e5b403-c5d1-4dc5-a5fd-d4b525058a38",
"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": "d4224341-8211-4e28-b13c-f6a0ca8c91c6",
"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-18T01:57:03.2278346+00:00"
},
"work_instruction_details_id": "e923c6fb-318a-4391-a093-610ea9932cd5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "67232639-b245-4453-bbdf-6f9be5e69b9a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "68be5f76-6eec-4239-8255-a7a1471594ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-18T01:57:03.2278346+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": "efb4fe3c-f633-4b84-9b7a-a3be68bff9e9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-18T01:57:03.2278346+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.