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": "2b219078-b543-418c-8f7b-a81b46692685",
"jobs_id": "d5ea5dc4-9e00-47ca-85e1-5c4f623f4f1d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "676367c3-ba9b-4a8a-98f0-d50d13f13e73",
"_parent_id": "0e7e9361-27b2-4b54-aea3-85a58a3e336e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e4c7070-32e7-4e35-ae02-6c883811607a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4b438fec-ca7c-4482-b4c1-2d91763c39bd",
"_parent_id": "5482bdde-b3b4-457c-ad1e-f0b0c14f8b82",
"root_parent_id": "476ee5c8-0fc1-49aa-ac83-228cb9679ce7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3cc7a53d-c285-4409-a23a-9d3f368593b0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "957e2ef3-e3fb-4c14-aa53-3fc85b627d8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9025266f-b2e8-48d7-bb19-728dd7262b5c",
"_parent_code": "sample string 6",
"sales_organization_id": "944fd709-e4cd-4b19-8479-a80d0fe7d718",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"equipment_model_id": "db13dcbb-2f13-42b1-b9f0-1806438f7e44",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "744737b7-4615-47bb-83d5-cb323268d4ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "22afca7d-bcd3-4d0e-b5f3-86e83ee53920",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3ad4625-87f6-4cf2-8fa0-d983b31c26b9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "380c5746-fb8b-4074-8561-317fb6199985",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"equipment_family_id": "b39ab183-9080-4b68-9338-6a09e8b1731a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "957e2ef3-e3fb-4c14-aa53-3fc85b627d8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9025266f-b2e8-48d7-bb19-728dd7262b5c",
"_parent_code": "sample string 6",
"sales_organization_id": "944fd709-e4cd-4b19-8479-a80d0fe7d718",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"date_in_production_since": "2026-08-31T06:14:31.9911655+00:00",
"date_out_of_production_since": "2026-08-31T06:14:31.9911655+00:00",
"date_end_support": "2026-08-31T06:14:31.9911655+00:00",
"sales_organization_id": "1a1b0ab7-940d-48de-9118-3c3cb1c23eff",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+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-31T06:14:31.9911655+00:00"
},
"project_status_id": "2440a67d-82f1-4bcd-a8d7-9600756873b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "bd606b0d-0129-43f1-8e66-210d0a2c629c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e9699f60-4496-44ef-bbdc-13949e2442ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"company_id": "bbb8af78-b93e-4eac-b388-f5053ebe8763",
"company_code": "sample string 12",
"db_address_id": "27053650-0daa-4e11-9e68-5df2f8ef059c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e2053a1b-8d1d-4ede-8f99-b5ae0e2d2a71",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9d756e5d-c86e-49be-ae8c-4b53c0960134",
"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-31T06:14:31.9911655+00:00",
"date_create": "2026-08-31T06:14:31.9911655+00:00",
"date_update": "2026-08-31T06:14:31.9911655+00:00",
"updated_by_user_id": "4bc1223c-96f1-401b-b3de-0982a4928cf0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-31T06:14:31.9911655+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-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-31T06:14:31.9911655+00:00",
"date_last_job": "2026-08-31T06:14:31.9911655+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-31T06:14:31.9911655+00:00",
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d608d9d-930f-4e7b-90ee-28dc98b3418b",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d838ac8-b165-4109-893d-9b0d34a2b9ba",
"name": "sample string 2",
"sales_organization_id": "70f0c486-3807-4a01-8e8a-c9f850caebda",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00",
"code": "sample string 7"
},
"job_priority_id": "c8abe779-2a5a-483b-869c-b015c0539987",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8011f63b-517b-4e9f-a74e-0825bf86de07",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "62c23caa-6f17-414d-a70e-df1fe8ab5528",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"job_status_id": "6f88d43e-47d9-4c73-88d7-d1a95a3f42ed",
"job_status_code": "sample string 11",
"db_address_id": "e864a2ae-c735-425b-bade-0f8c49ad2e15",
"contact_id": "406202d7-afe3-4874-9293-6458a071b4b8",
"requested_by_company_id": "8c438e5a-d14e-4777-8be2-496a1ae75df5",
"requested_by_contact_id": "013f7638-fc6e-41af-928b-ad4e42695181",
"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-31T06:14:31.9911655+00:00",
"due_date": "2026-08-31T06:14:31.9911655+00:00",
"date_create": "2026-08-31T06:14:31.9911655+00:00",
"date_update": "2026-08-31T06:14:31.9911655+00:00",
"date_closed": "2026-08-31T06:14:31.9911655+00:00",
"suggested_user_id": "ffcde281-6f1e-4494-80f5-758b582850ab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98f4aa17-4334-43a6-b502-65323dfc65d4",
"db_language_id": "93962568-720a-4a11-83f4-d7dcc8df241b",
"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-31T06:14:31.9911655+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "706abb2b-402a-4981-a7d8-39429377c283",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f4480e0f-82ec-4765-8183-389a9cfc85dc",
"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": "f01ed12a-e93a-4e89-ba38-050c6fb46405",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8020851a-6db3-40f9-9347-8f29d980ddbc"
},
"suggested_date_start": "2026-08-31T06:14:31.9911655+00:00",
"skill_id": "79a3ec3e-3c04-45a6-a1c5-df3fbbfc420d",
"skill_code": "sample string 32",
"skill": {
"id": "2aee2c35-440a-4765-a2de-d8e320d30cc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "976da7cb-fe78-4e31-a76c-f2119391ba21",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1065b05d-529e-447b-8d8c-e7045236fb6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "287e0fac-76fb-478d-9e19-27839daefa20",
"db_currency_id": "37b686e0-5b92-43aa-8a92-54f01514ac16",
"db_language_id": "312537c1-b6c2-41d3-a116-98cd26c8543f",
"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-31T06:14:31.9911655+00:00"
},
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "51178973-a034-49d9-b905-da9dde2de9f1",
"date_reported_by_company": "2026-08-31T06:14:31.9911655+00:00",
"id2": 36,
"company_id": "f888ae24-d75c-40f4-9f67-63e6b2162e96",
"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": "e32a5757-9d00-49d4-8a51-28fd976784eb",
"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-31T06:14:31.9911655+00:00"
},
"work_instruction_details_id": "fd70467e-9a9c-4e58-9c3d-dfb28ace9a46",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d694b8e0-fc4a-49cf-a9ab-4a51b37ebdcd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a03dbcbd-8f80-442c-b2f8-d155837677cb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-31T06:14:31.9911655+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": "66e735ea-bda4-4156-9806-04847b786fcb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-31T06:14:31.9911655+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.