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": "f8c52e14-cda7-4ded-aece-6fa5d08135e0",
"jobs_id": "ef572efa-0ee3-46d8-aa23-63c1e03bcf04",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6d7f5478-0946-4c95-9d90-7cca82ce49f2",
"_parent_id": "465703c6-c692-4949-85f7-cebb1812b5c4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a31d70f9-8889-4049-81a4-7e772bbccbda",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fc35dbe8-8d1a-44d0-909b-5fb27a451f1a",
"_parent_id": "ca9bd52a-8fcb-41c0-b386-f74577b94088",
"root_parent_id": "3e8ef9d4-2109-4f73-87ab-d488335bac70",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6f4a6125-7d7a-49a9-8493-ee5a4e822b87",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8f8fee71-b0cf-4093-8a15-2576cc021a63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c5c3606d-537a-4e85-abe1-871a4aa57a1d",
"_parent_code": "sample string 6",
"sales_organization_id": "4275b137-e8fb-4d84-ae35-453777671627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"modified_dateutc": "2026-11-05T10:26:22.8144824+00:00"
},
"equipment_model_id": "ffa2de5e-7ec9-407e-ac74-7b5c45bb9a02",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c766044-55fe-46da-877f-344b7ffe8810",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d9d37865-2f68-4490-8500-ae48a9a0918e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "42335bab-1ebf-4f05-9d02-b014d9699344",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "381b0c72-10b1-4901-b24b-c0be1ef78d4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"modified_dateutc": "2026-11-05T10:26:22.8144824+00:00"
},
"equipment_family_id": "6e4d7f46-74b5-41dd-aaa8-34a3cf0bf7c8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8f8fee71-b0cf-4093-8a15-2576cc021a63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c5c3606d-537a-4e85-abe1-871a4aa57a1d",
"_parent_code": "sample string 6",
"sales_organization_id": "4275b137-e8fb-4d84-ae35-453777671627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"modified_dateutc": "2026-11-05T10:26:22.8144824+00:00"
},
"date_in_production_since": "2026-11-05T10:26:22.8144824+00:00",
"date_out_of_production_since": "2026-11-05T10:26:22.8144824+00:00",
"date_end_support": "2026-11-05T10:26:22.8144824+00:00",
"sales_organization_id": "b1e3e137-6c1f-4435-89f9-b3be92a54655",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+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-11-05T10:26:22.831638+00:00"
},
"project_status_id": "ee5b8c0a-4e22-4611-bb5b-d923c2c881bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "913dd29d-8fef-4cbc-ad80-9371f705599c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65a26217-f3ab-4a44-b832-26bdeb5879bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00"
},
"company_id": "db0ede2a-e3b1-4fe3-afe5-4680b57ab76d",
"company_code": "sample string 12",
"db_address_id": "4e8d9131-37ea-4ae8-b1b4-cddaf3a8b2d5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b8498100-4b2a-4c11-ba8b-9b5676c3a25a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c246aa09-6d38-476a-88e1-839dc3c49dee",
"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-11-05T10:26:22.831638+00:00",
"date_create": "2026-11-05T10:26:22.831638+00:00",
"date_update": "2026-11-05T10:26:22.831638+00:00",
"updated_by_user_id": "4150800a-bd65-4c1c-938f-d5b4e255b736",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-05T10:26:22.831638+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-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-05T10:26:22.831638+00:00",
"date_last_job": "2026-11-05T10:26:22.831638+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-05T10:26:22.831638+00:00",
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00",
"is_mobile_installation": true
},
"job_type_id": "105212bc-4ba3-4c0d-bdbe-74a68fb958d7",
"job_type_code": "sample string 7",
"job_type": {
"id": "b68adf27-e60f-42d8-b68e-7b5839af42be",
"name": "sample string 2",
"sales_organization_id": "a2232ded-8879-405c-bb44-1168dbdb23b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00",
"code": "sample string 7"
},
"job_priority_id": "5415f37e-299b-42bc-ae32-bc73486ceb78",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "40ddc231-7def-41c9-ba33-5688d9f8f2ef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3920db5a-7f6c-403e-a70c-446bea3466f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00"
},
"job_status_id": "8a00c676-65ac-44fc-8a5b-79d9fd1d3093",
"job_status_code": "sample string 11",
"db_address_id": "0b1fc90e-35e9-4c91-9fc6-332085408c5b",
"contact_id": "d82bcfc7-43ae-459a-8c44-90d8b1366506",
"requested_by_company_id": "67cad213-0eb0-4e61-bdc1-770dd730663d",
"requested_by_contact_id": "b28ac0d2-1f5b-494c-80b9-ae01b8d8d131",
"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-11-05T10:26:22.831638+00:00",
"due_date": "2026-11-05T10:26:22.831638+00:00",
"date_create": "2026-11-05T10:26:22.831638+00:00",
"date_update": "2026-11-05T10:26:22.831638+00:00",
"date_closed": "2026-11-05T10:26:22.831638+00:00",
"suggested_user_id": "d015d895-44cb-4a39-92b5-eea1c26b9cb7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f6842b26-62e4-436f-ad70-1c950ca24159",
"db_language_id": "aa51ca54-cd72-4059-a10d-b9111e9dc1df",
"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-11-05T10:26:22.831638+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "61b26774-f609-4214-a2ba-0ab279d4bf89",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a2654cc-b147-4c11-94b3-0d735cd7ed65",
"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": "0a4adf19-58ef-4fa3-9f04-a2d1b62f793f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e08b47ad-646b-412e-b8f9-4586e35abc70"
},
"suggested_date_start": "2026-11-05T10:26:22.831638+00:00",
"skill_id": "e88f168c-707b-4a35-809f-b5558720d3be",
"skill_code": "sample string 32",
"skill": {
"id": "6218e58c-76d3-4438-b6c5-aba525db71f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "38d8a8f6-93e5-4042-b455-7827efc846df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf0a2adc-06b5-4aa9-94fe-0513ca78c0c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602dd739-43fe-4741-9dd0-6d8f7c4d9c01",
"db_currency_id": "caae019b-8717-43db-ba92-e2c6a5353ff3",
"db_language_id": "0ce0c642-7411-44df-a1d0-56e62c0078da",
"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-11-05T10:26:22.8144824+00:00"
},
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bbf37a12-c34a-4a7f-a990-57ea69d984e7",
"date_reported_by_company": "2026-11-05T10:26:22.831638+00:00",
"id2": 36,
"company_id": "9a4cb641-cea3-4dfa-9465-4550c36bbfb5",
"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": "04cfbe72-2694-4ee4-a760-14569dd01276",
"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-11-05T10:26:22.831638+00:00"
},
"work_instruction_details_id": "3c4bf3dd-e5de-40da-a53c-560f5e3083a8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d844133e-d8c6-427e-9da6-0f8ad529a7fc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "16f34544-301e-47c0-8b6e-432a55505eda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-05T10:26:22.831638+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": "0a16e033-e1b6-430b-aed1-ec96d1794efa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-05T10:26:22.831638+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.