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": "b167283e-7989-4ca6-b34a-cd5833577564",
"jobs_id": "6b6210b3-4360-4698-a3fb-68bbf323764e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "84ce694c-0bc6-4974-a9ef-bd9000c1dc19",
"_parent_id": "15fc15b7-f5b4-4d40-976c-0cc0af1778dc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e48f9900-b708-4191-bc77-901d555b35e0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ba702639-cc7c-47c1-ab47-2a8b8122eaf2",
"_parent_id": "7dc79895-4bee-486e-8daa-afd5134eaa4e",
"root_parent_id": "0457430d-64fb-4e6a-9fa1-8f9ecbffc7a1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e5e4ed81-2c3d-4c22-8a56-0178ee921b91",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "87b230f6-b327-4256-9230-99e3d792b3b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61d92e7d-7ac7-436f-88d8-dc696c2161bb",
"_parent_code": "sample string 6",
"sales_organization_id": "fb6cf070-6d0e-494d-b000-1768c9fdb6b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"equipment_model_id": "de1e0c7b-dd81-49e1-aee4-d45b598a8b8f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9014ee66-e023-4725-9607-4d9277f2fd2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dc71d3a1-518b-4957-8a52-35bde30cc53b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "58be2e1a-4c44-439d-9ef6-eeb626b778b4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "089c65cf-05d8-4c67-a6fe-778458d63ddc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"equipment_family_id": "9c394e3c-d78d-4a8d-92b5-a56cb27cb9cf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "87b230f6-b327-4256-9230-99e3d792b3b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61d92e7d-7ac7-436f-88d8-dc696c2161bb",
"_parent_code": "sample string 6",
"sales_organization_id": "fb6cf070-6d0e-494d-b000-1768c9fdb6b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"date_in_production_since": "2026-05-14T08:31:57.4168775+00:00",
"date_out_of_production_since": "2026-05-14T08:31:57.4168775+00:00",
"date_end_support": "2026-05-14T08:31:57.4168775+00:00",
"sales_organization_id": "95ee8212-e6de-4474-b642-f54a4392745e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+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-05-14T08:31:57.4168775+00:00"
},
"project_status_id": "4b672406-8818-4eee-be9e-a5a817e2c448",
"project_status_code": "sample string 10",
"project_status": {
"id": "2578de86-e8e9-47a7-b482-2af697d0ff22",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7ba476c7-f529-461c-9e9d-84fbdcc6e0e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"company_id": "ac30fe21-d181-4087-baa7-85f9d5e92922",
"company_code": "sample string 12",
"db_address_id": "cadfb1b5-3dd1-4586-b189-d81efb667e60",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "01421b0e-1414-4050-a497-a99682303981",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ec76451c-b4a4-4062-9137-c3532989af56",
"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-05-14T08:31:57.4168775+00:00",
"date_create": "2026-05-14T08:31:57.4168775+00:00",
"date_update": "2026-05-14T08:31:57.4168775+00:00",
"updated_by_user_id": "78a35443-da39-46b8-bfe4-9af9551f8458",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-14T08:31:57.4168775+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-05-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-14T08:31:57.4168775+00:00",
"date_last_job": "2026-05-14T08:31:57.4168775+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-14T08:31:57.4168775+00:00",
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00",
"is_mobile_installation": true
},
"job_type_id": "5094adeb-3070-48aa-a871-44ed74906da6",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6846391-63dc-4977-9064-4b7c325e6b6c",
"name": "sample string 2",
"sales_organization_id": "224c6fd0-593d-47fa-b03d-c7d6afffcbfa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00",
"code": "sample string 7"
},
"job_priority_id": "854aaa28-1085-4c57-ac60-d6d9329224b3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31aec0c0-ff61-4195-87e0-73be4b39970a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "36f55e41-6291-4a12-814f-0c50344765aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"job_status_id": "9efff31c-20da-4f2b-9be3-80a0aa2265a9",
"job_status_code": "sample string 11",
"db_address_id": "2de0b7ed-02e3-49bb-8577-d5bee584adc4",
"contact_id": "8bbdd502-9126-4ab4-bb6f-e51c9f90ccf3",
"requested_by_company_id": "18f63818-ab6e-4817-92a8-67a6e6a4b9ed",
"requested_by_contact_id": "052724b9-3bf0-48a8-ab83-005636b76fbb",
"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-05-14T08:31:57.4168775+00:00",
"due_date": "2026-05-14T08:31:57.4168775+00:00",
"date_create": "2026-05-14T08:31:57.4168775+00:00",
"date_update": "2026-05-14T08:31:57.4168775+00:00",
"date_closed": "2026-05-14T08:31:57.4168775+00:00",
"suggested_user_id": "de362109-0a0f-42b2-948e-3693fbef862f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "82a5b05f-f3dd-44b5-9f59-22ed89220435",
"db_language_id": "4a247db8-31f5-424d-beaf-8f3c6e104425",
"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-05-14T08:31:57.4168775+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "462d636f-ca52-4ffe-9b37-749c0f9ede2a",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "66e54a6f-d03b-4d10-9e95-e5362a9d04d2",
"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": "1d41dcad-ec35-4975-b8b0-7d4332ba41ce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "85f65350-694f-4915-9158-ef2a04669755"
},
"suggested_date_start": "2026-05-14T08:31:57.4168775+00:00",
"skill_id": "c8f4d90b-72f4-4ede-b769-26f2c002fa7e",
"skill_code": "sample string 32",
"skill": {
"id": "6d3f70ff-becd-4fad-800c-c18c4f079827",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "549c2cce-2945-4e59-9443-3e6af94fe4de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14052007-cfa8-43a1-ab15-00f2c4522837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29b183d4-b86a-45cb-988e-60ecf84d2a7c",
"db_currency_id": "90880f5a-f296-4f82-97b8-79da5155248f",
"db_language_id": "bd5e79fb-5b07-44c0-8ade-945feefa06d0",
"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-05-14T08:31:57.4168775+00:00"
},
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bb6ba0c3-e318-4bfc-8d18-b698d223422b",
"date_reported_by_company": "2026-05-14T08:31:57.4168775+00:00",
"id2": 36,
"company_id": "28496c7f-0b39-4069-b25a-5348c19ca99f",
"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": "32ac623a-224e-4d29-be0c-c623c79d970e",
"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-05-14T08:31:57.4168775+00:00"
},
"work_instruction_details_id": "13d7416d-828d-40b8-b588-7965a357ef36",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "670f7ccf-5eb5-4c16-ac74-39d26a254d87",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "453bf7a3-ece2-4712-80b5-979b4a3ccefe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-14T08:31:57.4168775+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": "4cc4e1e6-58aa-4804-808a-9add0fb4c78a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-14T08:31:57.4168775+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.