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": "54a3c182-a31c-4eb5-8bd8-68e92cd03078",
"jobs_id": "66b37763-3ab1-4f8a-a71b-6567db991b24",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2edbd503-c6af-4fd0-9869-c6291a95baa2",
"_parent_id": "b6353a4a-ebee-4f29-8a4f-715f5a7f6efc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dcbbc16b-903c-40c1-8e8a-8e8e42d4ff7f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7e475432-2b9e-4375-a990-a4058a980f23",
"_parent_id": "4cf668e0-aa9c-4906-9cb0-0e777a422970",
"root_parent_id": "d67d4b70-ecdf-491f-8b31-14b52fab7c26",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b98379c5-b0ba-4942-94d0-9aeec850f4d8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "39aed038-6615-4d5e-ace4-1edab4806bf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "832e2e46-99d5-4f09-8692-338232e02a41",
"_parent_code": "sample string 6",
"sales_organization_id": "8516d5ac-3c19-49bb-93e7-3a484dc09e8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00"
},
"equipment_model_id": "0fd4274c-1556-4fa5-9183-428a71161eed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4b7f526a-7071-44aa-b02f-f90bd17fb7eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3fdaeef7-cc92-48a1-b6fc-64b2eb5565ee",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4c02e0b6-c497-4059-a1ed-a86a20d3663e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e132c5e7-64a4-4efd-9545-9bd18d4b6b27",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00"
},
"equipment_family_id": "a715eb26-b1e3-4687-90e0-e1ec85c96560",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "39aed038-6615-4d5e-ace4-1edab4806bf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "832e2e46-99d5-4f09-8692-338232e02a41",
"_parent_code": "sample string 6",
"sales_organization_id": "8516d5ac-3c19-49bb-93e7-3a484dc09e8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00"
},
"date_in_production_since": "2026-06-27T03:45:26.7127683+00:00",
"date_out_of_production_since": "2026-06-27T03:45:26.7127683+00:00",
"date_end_support": "2026-06-27T03:45:26.7127683+00:00",
"sales_organization_id": "55e6ea39-f8bc-45d9-a50a-8aaaf8c3aae0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+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-06-27T03:45:26.7127683+00:00"
},
"project_status_id": "91a9319d-e34c-4478-9cc7-ccdf45ffdd43",
"project_status_code": "sample string 10",
"project_status": {
"id": "d6b8f03b-646d-43ea-b4d6-befb46c3a4ac",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e9697f66-2c6e-4507-9f71-67a9d1aee15c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00"
},
"company_id": "808b7564-e248-459d-aa5d-6fa56bd8c475",
"company_code": "sample string 12",
"db_address_id": "9c861503-3508-47c5-a849-d646bff277bb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4f0c5c3c-43b1-4d5b-8a36-f0ad01174c8d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "40a27e9f-45e7-443d-8962-9aeb3f6d0b6b",
"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-06-27T03:45:26.7127683+00:00",
"date_create": "2026-06-27T03:45:26.7127683+00:00",
"date_update": "2026-06-27T03:45:26.7127683+00:00",
"updated_by_user_id": "c4f62f44-22e1-4fdd-87d3-f9c94cc7a8c4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-27T03:45:26.7127683+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-06-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-27T03:45:26.7127683+00:00",
"date_last_job": "2026-06-27T03:45:26.7127683+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-27T03:45:26.7127683+00:00",
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00",
"is_mobile_installation": true
},
"job_type_id": "98bc1593-1efa-4640-98d5-2c32540c5a43",
"job_type_code": "sample string 7",
"job_type": {
"id": "ce1dc257-58c7-4221-913c-0a2dea7ae68f",
"name": "sample string 2",
"sales_organization_id": "77dcd9df-53b0-4030-9480-7f7facd6e098",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00",
"code": "sample string 7"
},
"job_priority_id": "d0bf0a2f-66c6-4acc-8aa3-7da6dbeeb1a3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bc37f859-9aed-4b34-b225-f4193340e99c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "76aa5745-87a1-4189-b884-de3e5ef158d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00"
},
"job_status_id": "b69c2180-9fc9-46c3-be5f-e5a5421b77c4",
"job_status_code": "sample string 11",
"db_address_id": "000c1852-013e-45d3-a094-9d96bc760ca9",
"contact_id": "7d1af8d9-0f3a-4028-a9de-ba0332dcbb32",
"requested_by_company_id": "502d557c-389d-4393-9efd-9194870d00c6",
"requested_by_contact_id": "fdf6a6bb-eab4-41a2-938d-c0bc51ffafb4",
"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-06-27T03:45:26.7127683+00:00",
"due_date": "2026-06-27T03:45:26.7127683+00:00",
"date_create": "2026-06-27T03:45:26.7127683+00:00",
"date_update": "2026-06-27T03:45:26.7127683+00:00",
"date_closed": "2026-06-27T03:45:26.7127683+00:00",
"suggested_user_id": "b40e3e6a-2434-43f9-ae4b-f5709ec46442",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c6ea46e6-d54a-4425-b046-388190e675b4",
"db_language_id": "d1ec5184-80dc-443c-8553-30aefe9c8a82",
"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-06-27T03:45:26.7127683+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c5830554-ba68-4f01-a7fb-3cf0105060c8",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9cf82e16-cfcc-4f79-9c89-de024be2b0b0",
"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": "d6bbc8ca-5a03-4308-a6ca-f5cfefeb4af8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-27T03:45:26.7127683+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "caaf4a54-38c7-49f4-aeb8-dc0c1ddb54b9"
},
"suggested_date_start": "2026-06-27T03:45:26.7127683+00:00",
"skill_id": "0e2b1ecc-4e89-47cb-abe6-bf92044a06c6",
"skill_code": "sample string 32",
"skill": {
"id": "4bcbcc2b-028e-4686-92b5-cb6c662ea6ee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f818456-c4a1-472e-9d30-dbb62f7b3b25",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f1a8815-55f3-4afb-8e63-ff47bd12c3fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82fe500f-5d0a-4167-9b60-9e503dba25c8",
"db_currency_id": "5094c49d-8cf1-4d43-a0a0-130a0404cd95",
"db_language_id": "b5f697be-6504-46b4-8966-a4aa4167038b",
"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-06-27T03:45:26.7127683+00:00"
},
"modified_dateutc": "2026-06-27T03:45:26.7283879+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a20c87de-b467-4bf7-83e9-61e8feb3ae32",
"date_reported_by_company": "2026-06-27T03:45:26.7283879+00:00",
"id2": 36,
"company_id": "7e2383c9-a64a-46de-a221-46b374893517",
"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": "f2d8cb02-3db3-42ee-98a9-538771e1ff53",
"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-06-27T03:45:26.7283879+00:00"
},
"work_instruction_details_id": "383b6a03-c06b-4bb1-8eab-d21e08d8ec0a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "921803d1-c271-48aa-85ba-f45d93396688",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a050a090-c164-4fd6-8510-9183fe3e217b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-27T03:45:26.7283879+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": "0edd787f-07c3-42b4-97ca-09ee4064aab7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-27T03:45:26.7283879+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.