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": "91b4ce1f-16c8-40aa-83b4-2d7ae4b93446",
"jobs_id": "2abf4ba7-feeb-46b3-a230-7f82ba5edb01",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c6ebb0f7-9a46-4665-abca-247de4e06be1",
"_parent_id": "ed1762ef-1235-4439-a2a1-5852a2698e69",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "97b92912-1735-4e01-aa9c-24f242a484ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "333f1384-988c-492e-bb48-14955b7a5e67",
"_parent_id": "593a8760-2daa-42d1-9871-2bb9aefb4bbc",
"root_parent_id": "49404f89-5efb-4eef-8e78-aa16f3c65e2b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cfec08c1-cd7b-4215-a59a-163def938b6d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0b4616c4-f053-4fb0-81dc-b145415bcfc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2fb032a4-be21-4e90-b7d7-da7f66799ac4",
"_parent_code": "sample string 6",
"sales_organization_id": "cc249842-ec0b-45dc-891b-f2f33b69c8e8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"modified_dateutc": "2026-10-10T17:20:21.7947459+00:00"
},
"equipment_model_id": "657fd90d-bf5e-466e-8ec1-f7d22f5c5ff0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "82178ab7-c4e6-4601-8dad-b83ddf7d056a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "13e189f1-6708-4931-899c-9f01de6ab4b5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "da4f2f05-f45d-4de1-b87b-7e5d0d78e886",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aeb427a4-3212-4dfc-8e96-2bfa70db2266",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"modified_dateutc": "2026-10-10T17:20:21.7947459+00:00"
},
"equipment_family_id": "ca032195-e8de-4d93-9c95-5fe7fd8b2ba8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0b4616c4-f053-4fb0-81dc-b145415bcfc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2fb032a4-be21-4e90-b7d7-da7f66799ac4",
"_parent_code": "sample string 6",
"sales_organization_id": "cc249842-ec0b-45dc-891b-f2f33b69c8e8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"modified_dateutc": "2026-10-10T17:20:21.7947459+00:00"
},
"date_in_production_since": "2026-10-10T17:20:21.7947459+00:00",
"date_out_of_production_since": "2026-10-10T17:20:21.7947459+00:00",
"date_end_support": "2026-10-10T17:20:21.7947459+00:00",
"sales_organization_id": "da84704b-3b11-4021-af80-7712e1c9ffc3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+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-10-10T17:20:21.7947459+00:00"
},
"project_status_id": "0b49aacf-4808-41e3-b5d1-2ddce10f4358",
"project_status_code": "sample string 10",
"project_status": {
"id": "de21fb4c-5881-4e27-80db-5ae8c7946528",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e33b3a5c-9c73-416c-8558-37fb6934e780",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T17:20:21.7947459+00:00"
},
"company_id": "3a8eec47-5177-437c-84cc-403e2e3a8c85",
"company_code": "sample string 12",
"db_address_id": "0ad1167f-3118-40e5-b93e-8482104ec05d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "828b1cae-b4ed-470d-8f93-0aba21d9d604",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e27e5162-b5b7-4734-b919-05f7ed050e7d",
"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-10-10T17:20:21.7947459+00:00",
"date_create": "2026-10-10T17:20:21.7947459+00:00",
"date_update": "2026-10-10T17:20:21.7947459+00:00",
"updated_by_user_id": "7170b767-0cf8-468b-a0b3-a3e527bb5c31",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-10T17:20:21.7947459+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-10-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-10T17:20:21.8109145+00:00",
"date_last_job": "2026-10-10T17:20:21.8109145+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-10T17:20:21.8109145+00:00",
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00",
"is_mobile_installation": true
},
"job_type_id": "88997fca-f38d-4e1b-9259-d4dd3ad4d7a9",
"job_type_code": "sample string 7",
"job_type": {
"id": "4755fd64-284f-463e-a885-cad1fbb4dc66",
"name": "sample string 2",
"sales_organization_id": "f59d55ba-4fb8-4b07-8034-a245a008eda5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00",
"code": "sample string 7"
},
"job_priority_id": "6a57aec0-3120-44c9-86b6-b00c25d68172",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "df52166c-0c15-43cc-8d79-9a08f4e8daeb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "51cec938-b91c-4de1-8783-8b9f86dce039",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00"
},
"job_status_id": "d7475558-af38-4573-a08a-ee813079f99d",
"job_status_code": "sample string 11",
"db_address_id": "a1666818-f132-4363-a889-953fd3274061",
"contact_id": "9db82946-3b7f-4623-a668-3acedd2f0276",
"requested_by_company_id": "ea2431a4-1dbe-4739-9ab6-6a038cf1e627",
"requested_by_contact_id": "4bd64d85-597d-483b-bd15-df04c7e99971",
"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-10-10T17:20:21.8109145+00:00",
"due_date": "2026-10-10T17:20:21.8109145+00:00",
"date_create": "2026-10-10T17:20:21.8109145+00:00",
"date_update": "2026-10-10T17:20:21.8109145+00:00",
"date_closed": "2026-10-10T17:20:21.8109145+00:00",
"suggested_user_id": "81f00280-3633-48c6-b412-6799473ebfb6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8a7d5061-6e42-4422-a1a8-cedc76ea6961",
"db_language_id": "ed0a5b7a-c1f6-4382-9441-85cc1a42b1d5",
"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-10-10T17:20:21.8109145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a328238e-d5b8-4c65-a55a-f00577d920a3",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9946c2f2-05e2-4006-b514-0581c5ff4976",
"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": "683f8962-e2cf-4508-81ee-c7486711c322",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4efa11a4-ac43-4e0f-b3ab-6054b279de2b"
},
"suggested_date_start": "2026-10-10T17:20:21.8109145+00:00",
"skill_id": "27f0c5c1-a254-4cc7-a57e-123e6be81e93",
"skill_code": "sample string 32",
"skill": {
"id": "93e9ad3f-2132-46b8-8615-274f8f25a1b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "88e91284-6ccb-4ae5-9dd9-2f0b940b4838",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ab1a973-cb54-403b-b014-32ae9a2911fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b6b26b-e7b3-4677-84cf-058b67b1f2dc",
"db_currency_id": "e45ed601-c443-4516-bbb8-41178639d557",
"db_language_id": "d61dc825-6117-4a96-8958-0257303c4d95",
"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-10-10T17:20:21.7947459+00:00"
},
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "03ff68dc-8258-40e0-b430-5371f3ef5d0a",
"date_reported_by_company": "2026-10-10T17:20:21.8109145+00:00",
"id2": 36,
"company_id": "6429a528-fd9a-4556-8ac7-451a96a4915e",
"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": "c3af582e-7698-4bba-b592-368d500e9bdd",
"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-10-10T17:20:21.8109145+00:00"
},
"work_instruction_details_id": "ef0ecd38-1db2-479f-848e-18dd4c92b2fd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e11fe55-441a-40c0-9a45-2cf8442e5165",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e04e35f8-fc9b-4478-abc1-13b9d9b12690",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-10T17:20:21.8109145+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": "13f34f0e-42b3-40ce-b70c-49d7bed0bc66",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-10T17:20:21.8109145+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.