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": "9d9e18cd-491e-40e5-ae67-d34b438f8457",
"jobs_id": "c0dcbd3d-4f19-41b2-a781-c0418317212e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3c9a40f2-e8c3-419d-8b7b-8317456bde66",
"_parent_id": "ac89705c-0eb2-4b90-a82a-2b5fa1da57c3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "067eb869-f56f-4bd7-940a-d4529a6051ae",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9c1afa46-9178-4f07-b758-588ab600dd84",
"_parent_id": "6e95ff2a-518f-48c4-befd-5b8d80a2692f",
"root_parent_id": "7d1fcff1-be6c-4863-860d-8815c2f4b6fd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "35305178-f1ef-42ec-895b-2532d1532702",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "79da423b-06cc-4727-854a-56bc78c10c37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c24dd185-4a2e-400a-ba68-827713cdd2a5",
"_parent_code": "sample string 6",
"sales_organization_id": "9fb472be-d9fd-40b0-9e2e-258530acb05c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"equipment_model_id": "3758a0e7-81fb-4c53-9a33-28d6edea0c0c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "34131a57-27a0-4b3d-950d-c9fa0c72f730",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "208508df-ef57-464a-b2ac-a45f11fde18b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aabcd520-4335-4baf-b799-c44e4c6a2cb8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e0e6ec1d-52f7-4c38-acfd-d1721ebc5382",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"equipment_family_id": "e5abfa9a-a987-412e-aeed-c92d550443a8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "79da423b-06cc-4727-854a-56bc78c10c37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c24dd185-4a2e-400a-ba68-827713cdd2a5",
"_parent_code": "sample string 6",
"sales_organization_id": "9fb472be-d9fd-40b0-9e2e-258530acb05c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"date_in_production_since": "2025-09-04T14:41:26.8557412+00:00",
"date_out_of_production_since": "2025-09-04T14:41:26.8557412+00:00",
"date_end_support": "2025-09-04T14:41:26.8557412+00:00",
"sales_organization_id": "1c8d02c3-fb17-4620-a42f-eba3f4c95301",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+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-09-04T14:41:26.8557412+00:00"
},
"project_status_id": "d9255093-b98d-48aa-99ad-5f4665cfa031",
"project_status_code": "sample string 10",
"project_status": {
"id": "7351b361-57db-4a8c-8531-498b665f4ae6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e87c2ea1-b1e2-48bf-9221-c174550c1e1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"company_id": "1db481b3-038e-4f17-8c4c-915fcdbb6b7a",
"company_code": "sample string 12",
"db_address_id": "a408842e-d4e6-4603-b5cf-57345b01d4dc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7e83ede0-199b-4b4a-b90e-afc50f3ece6f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "84e2bed8-4631-4fcc-a02e-29a5501a340a",
"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-09-04T14:41:26.8557412+00:00",
"date_create": "2025-09-04T14:41:26.8557412+00:00",
"date_update": "2025-09-04T14:41:26.8557412+00:00",
"updated_by_user_id": "a5ada165-8731-4ed5-8f59-fd49086721eb",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-04T14:41:26.8557412+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-09-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-04T14:41:26.8557412+00:00",
"date_last_job": "2025-09-04T14:41:26.8557412+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-04T14:41:26.8557412+00:00",
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00",
"is_mobile_installation": true
},
"job_type_id": "dd074ffd-3f6c-4d1b-a0b1-a10d86f0b232",
"job_type_code": "sample string 7",
"job_type": {
"id": "610d35f5-77b3-40bd-a142-a24fb1c2048d",
"name": "sample string 2",
"sales_organization_id": "9a3fbdfe-f172-46b3-9fd3-c08b6ea28d0b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00",
"code": "sample string 7"
},
"job_priority_id": "58be4829-a37f-4706-8802-6786d148d957",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c9152b52-29da-4c91-95ff-13042db4c3e1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f87b5d39-1e21-4612-b23e-380a4dab6647",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"job_status_id": "e637bcfd-1ce2-45c4-acac-db18c85cb6d0",
"job_status_code": "sample string 11",
"db_address_id": "c9439ac8-c714-4768-910d-c109567f8bee",
"contact_id": "82a46bfe-a972-418d-a117-02888d47b826",
"requested_by_company_id": "95119c66-262b-4c80-ac81-9bd1e4e93493",
"requested_by_contact_id": "c097263c-01e9-4828-8751-c19e22a36b25",
"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-09-04T14:41:26.8557412+00:00",
"due_date": "2025-09-04T14:41:26.8557412+00:00",
"date_create": "2025-09-04T14:41:26.8557412+00:00",
"date_update": "2025-09-04T14:41:26.8557412+00:00",
"date_closed": "2025-09-04T14:41:26.8557412+00:00",
"suggested_user_id": "7d0899aa-8475-484f-be04-38be0e2087c1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "15977e96-ce74-44fe-8ff0-9d28bf13710f",
"db_language_id": "efeb70fc-7f44-4f85-9cd8-410fbb477739",
"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-09-04T14:41:26.8557412+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2103da89-7f5a-4a47-aaa5-15bd62118116",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d542fd7a-68be-4398-9905-e83ccf631fbc",
"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": "c32b2b87-bd15-431f-a6b0-b4510659ac99",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9f11211c-72e7-4048-8b7e-a9c97c115135"
},
"suggested_date_start": "2025-09-04T14:41:26.8557412+00:00",
"skill_id": "34060726-5f04-4e1b-9b25-fc4fd552afb8",
"skill_code": "sample string 32",
"skill": {
"id": "a6799a41-4671-460f-a84d-660dc8af6708",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a2b3249c-bb00-4c79-8da6-82f4014d2135",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea58ed46-ac29-4061-b081-489b2460ba63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "058ec6e6-7e01-4295-84a9-c60c066ba2cf",
"db_currency_id": "ca3b9d3a-45cd-4713-9105-2d5b9cba4e8f",
"db_language_id": "0e5153f2-66dd-47dc-baaf-ccdd8739fa77",
"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-09-04T14:41:26.8557412+00:00"
},
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c71c5bf1-c359-4eb6-a45f-0fa710c2c811",
"date_reported_by_company": "2025-09-04T14:41:26.8557412+00:00",
"id2": 36,
"company_id": "f059ec0e-199b-4184-a9ae-cd72543b9e52",
"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": "a2ee9ca9-5d71-42d3-b0f0-60251daafa7f",
"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-09-04T14:41:26.8557412+00:00"
},
"work_instruction_details_id": "2b603d99-42fa-4854-9649-c799b948a633",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bb76bc44-9d51-4dd2-a679-45c2b9658a76",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "69948791-9a72-47ce-97df-8fa3c6f01585",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-04T14:41:26.8557412+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": "9fb0b4dd-9a05-4bdf-b692-e035d17fde48",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-04T14:41:26.8557412+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.