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": "d8969428-0cf0-4596-b565-5f4880569522",
"jobs_id": "9c2c6090-f887-42db-918a-b61faa90fcae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2d0c2766-f7a6-4395-a60c-e2d37e5190e3",
"_parent_id": "97e674ab-06c5-4b5f-b63e-d8994dfb206d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7de31094-14f3-4928-9586-1850387e0696",
"project_reference_back_office": "sample string 5",
"project": {
"id": "16fa208c-0b66-42c4-af47-5f632a068125",
"_parent_id": "289a92a2-9d10-47f2-ac63-be91ff04aaaa",
"root_parent_id": "b61cef9f-ea24-4d8d-a62e-1622c9fb4b9b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0f8bfca-a671-48e8-a523-642b81749222",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c5df95d7-ce64-44a1-839a-5ea11c0a8e48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4024ce4-14c4-42b9-b0a8-5399b62b067a",
"_parent_code": "sample string 6",
"sales_organization_id": "b6d7d3b2-1f0d-41a0-b59e-a07be38e87a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"modified_dateutc": "2025-12-20T16:06:38.7426544+00:00"
},
"equipment_model_id": "5ef196e3-19b5-41ef-ad74-057d548463ff",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7d741a37-f3b0-4c82-a17a-a25d93e19ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "33fb24ce-6151-4c4e-babe-9411d2eb9f90",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "31d53c08-de8c-4689-b202-68e3cf4ed236",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7b0b4f31-d055-46d1-9ac1-5584f9e712a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00"
},
"equipment_family_id": "bbadb249-6f5e-4947-82d4-d117f05b5f71",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c5df95d7-ce64-44a1-839a-5ea11c0a8e48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4024ce4-14c4-42b9-b0a8-5399b62b067a",
"_parent_code": "sample string 6",
"sales_organization_id": "b6d7d3b2-1f0d-41a0-b59e-a07be38e87a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"modified_dateutc": "2025-12-20T16:06:38.7426544+00:00"
},
"date_in_production_since": "2025-12-20T16:06:38.7582759+00:00",
"date_out_of_production_since": "2025-12-20T16:06:38.7582759+00:00",
"date_end_support": "2025-12-20T16:06:38.7582759+00:00",
"sales_organization_id": "1f0c5d78-c07e-4f2a-ab22-978e9ebd611a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+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-12-20T16:06:38.7582759+00:00"
},
"project_status_id": "9a662732-a080-499f-adbe-1b22379c3492",
"project_status_code": "sample string 10",
"project_status": {
"id": "8fd6e3f4-e193-41e4-8c53-2c7bb525db07",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0f4ca666-e8c3-49c8-866c-6147777ffdf8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00"
},
"company_id": "6abbae23-6fc7-40ac-a975-12ec8e3e637f",
"company_code": "sample string 12",
"db_address_id": "43e80af2-b750-449f-a0f2-7cdb0cdb129f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7c4b36bf-65f2-4b79-82c4-a102b1ca46b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1f485c8f-ba69-4d1b-8023-3c419a3f32aa",
"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-12-20T16:06:38.7582759+00:00",
"date_create": "2025-12-20T16:06:38.7582759+00:00",
"date_update": "2025-12-20T16:06:38.7582759+00:00",
"updated_by_user_id": "4b4c9ab5-752e-4da6-93e5-aaeb6ede9495",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-20T16:06:38.7582759+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-12-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-20T16:06:38.7582759+00:00",
"date_last_job": "2025-12-20T16:06:38.7582759+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-20T16:06:38.7582759+00:00",
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00",
"is_mobile_installation": true
},
"job_type_id": "dac89dd4-e2fa-4901-95d8-ab2672f50716",
"job_type_code": "sample string 7",
"job_type": {
"id": "3961424c-4299-4809-aff0-3e52c9252f67",
"name": "sample string 2",
"sales_organization_id": "3829e8e4-3e59-46bf-95d9-71b9bd1d54db",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00",
"code": "sample string 7"
},
"job_priority_id": "3a97ece7-e3dc-4cab-977c-ffd633541cbd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2324553e-73f8-4e2a-9f9c-150510913d8d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c54fc35-83c5-4cf1-a399-6e057bbbdfa1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00"
},
"job_status_id": "ada44a74-7177-41d2-8616-b9d5984d0119",
"job_status_code": "sample string 11",
"db_address_id": "e98e14a9-3390-4b0e-ac01-2eed29139850",
"contact_id": "c0cc309f-6db8-4df4-aa7f-1068f8f92656",
"requested_by_company_id": "bec0d6c8-ac53-4229-8eb1-e5a222dc6ee8",
"requested_by_contact_id": "56508cff-9722-4168-b1e3-5e3bb42a7380",
"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-12-20T16:06:38.7582759+00:00",
"due_date": "2025-12-20T16:06:38.7582759+00:00",
"date_create": "2025-12-20T16:06:38.7582759+00:00",
"date_update": "2025-12-20T16:06:38.7582759+00:00",
"date_closed": "2025-12-20T16:06:38.7582759+00:00",
"suggested_user_id": "10b244e0-f8fa-4578-a853-c3febba6c37f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "46fe7bee-ef16-4eb8-829e-0c508b9d0ae5",
"db_language_id": "9befeb7c-bb79-4457-b5fc-fe61daf45509",
"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-12-20T16:06:38.7582759+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c8db6ac-6f7e-4bdc-91ed-8f5d46977ff0",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d854bcda-7510-4626-8c31-0d3a266e7da8",
"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": "aa5261dc-834b-4f49-af08-ca65a1ee98b3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "17d149d6-e6ae-4351-9c09-3a75828d391f"
},
"suggested_date_start": "2025-12-20T16:06:38.7582759+00:00",
"skill_id": "ba7b0a7a-404a-4833-87cb-0af1d73fa295",
"skill_code": "sample string 32",
"skill": {
"id": "8d4b3504-6f42-4e73-8e84-5d6b2683f476",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5b7c189c-fefb-40b2-8ed1-c0e8712b938a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7aaf26cc-cafb-46d5-b550-8f1d2351a234",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7cf374e-59dd-4e79-b989-7a4591847d2d",
"db_currency_id": "2eba0069-7196-4266-a922-be31a10ba69f",
"db_language_id": "2e881722-f206-48d7-b99e-40b62340eabc",
"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-12-20T16:06:38.7426544+00:00"
},
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4eccd9eb-6898-4e44-988f-7e4a77b81201",
"date_reported_by_company": "2025-12-20T16:06:38.7582759+00:00",
"id2": 36,
"company_id": "da237020-0c4a-4409-a31d-72041729c4fb",
"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": "d3ee6d3f-8885-485b-9578-80eb896743a0",
"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-12-20T16:06:38.7582759+00:00"
},
"work_instruction_details_id": "f8175979-2c98-4b7c-96b9-4ad45ebec52c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c65a3cda-3856-43b6-9911-ab8864c9d3bf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0a6a46ed-8060-4efe-a7a4-0e96159832c4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-20T16:06:38.7582759+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": "72a5feec-eef3-4e40-b3d3-9b4e88be8539",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-20T16:06:38.7582759+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.