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": "8434a3cc-d45d-4d9d-b925-295502a1faf8",
"jobs_id": "e42a97c1-a1e1-4b17-a912-c0b4aa421310",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fed57dc3-d26a-4593-9432-b94f15a0972b",
"_parent_id": "c9c527c2-bae4-41e3-bb65-5ff2686c91fe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f22d64e9-828c-42e4-9a2a-c5850049ad21",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9b5c629a-9487-4a2b-bc75-1976fdeb9d38",
"_parent_id": "5e9d2add-3806-4d46-bac2-5aac6733191d",
"root_parent_id": "7f6ece04-462c-4045-aadd-07dd60d3b17e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9101d5b1-ea6b-4e15-b8f8-6325eefa7b21",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2e5e7808-cff0-4645-813c-bd4d3e9df6f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2e61844-d612-4789-80c4-cf96182411b9",
"_parent_code": "sample string 6",
"sales_organization_id": "df30140b-1c44-48f7-ac28-6f6d87546045",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"equipment_model_id": "845e86dd-0a23-48a6-8118-9ceeae860315",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8066d916-8db6-4088-ba7c-a980b002e766",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cc6fe869-3dc2-4c6e-91ef-609f7b6e3915",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "55b90302-8db4-42a0-b873-2cad0bb4ca9e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cb175c05-f534-4208-b6de-6662bbef11f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"equipment_family_id": "5f075b6d-fd45-42d0-96ec-5bf5e4b0fb00",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2e5e7808-cff0-4645-813c-bd4d3e9df6f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2e61844-d612-4789-80c4-cf96182411b9",
"_parent_code": "sample string 6",
"sales_organization_id": "df30140b-1c44-48f7-ac28-6f6d87546045",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"date_in_production_since": "2026-09-13T20:24:21.9263774+00:00",
"date_out_of_production_since": "2026-09-13T20:24:21.9263774+00:00",
"date_end_support": "2026-09-13T20:24:21.9263774+00:00",
"sales_organization_id": "d229da63-b3ca-4a2f-8653-29fc1a256589",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+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-09-13T20:24:21.9263774+00:00"
},
"project_status_id": "c0b8d8d0-e3f4-435e-bd9e-3b7500e9091a",
"project_status_code": "sample string 10",
"project_status": {
"id": "4ba9ed65-5f10-4f3f-97ab-56aaa6c33d4a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb0ebba4-c698-47e4-bfbd-a188b320270c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"company_id": "d6ac1c59-4998-4fae-9ba7-91722c5d9775",
"company_code": "sample string 12",
"db_address_id": "386bea75-9049-4ea1-abf1-ca402d8a30ab",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5de223cf-0c17-4ca7-a111-63e218258440",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6fe4aa74-dc23-491c-ac09-e6f58eb07037",
"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-09-13T20:24:21.9263774+00:00",
"date_create": "2026-09-13T20:24:21.9263774+00:00",
"date_update": "2026-09-13T20:24:21.9263774+00:00",
"updated_by_user_id": "f333830e-eb07-4d23-8309-2dbb7206629e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-13T20:24:21.9263774+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-09-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-13T20:24:21.9263774+00:00",
"date_last_job": "2026-09-13T20:24:21.9263774+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-13T20:24:21.9263774+00:00",
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c1fb28b-85e3-4db7-825a-7a158eccdb5f",
"job_type_code": "sample string 7",
"job_type": {
"id": "31abe289-7686-4e7c-bdef-b8b9746afd38",
"name": "sample string 2",
"sales_organization_id": "1f789c38-e8fb-47a7-a667-62f88311468d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00",
"code": "sample string 7"
},
"job_priority_id": "64ef2794-2650-4fc6-8250-6e88bd731cea",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8e93cd17-f163-4bc1-9a9a-b7a7963de1f2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2f96e401-9f99-4db5-8776-d6d3fb4dd2e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"job_status_id": "1fae6429-e1c1-4451-b149-78519a2456a7",
"job_status_code": "sample string 11",
"db_address_id": "33d78a47-47cf-4853-80d9-9054546bdc2e",
"contact_id": "05a7cc7e-0b82-4395-9b1f-68bc3b174f94",
"requested_by_company_id": "e4918adb-ca9c-4b61-9c14-f88448011a12",
"requested_by_contact_id": "dcd77750-b88a-415e-b80f-d68c1a84c53a",
"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-09-13T20:24:21.9263774+00:00",
"due_date": "2026-09-13T20:24:21.9263774+00:00",
"date_create": "2026-09-13T20:24:21.9263774+00:00",
"date_update": "2026-09-13T20:24:21.9263774+00:00",
"date_closed": "2026-09-13T20:24:21.9263774+00:00",
"suggested_user_id": "b65bba8c-0dcb-4a20-b4ed-9e968d5a77b3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "197ed060-b564-48c0-9031-be74cd3bfe15",
"db_language_id": "40c1d304-201d-481e-bdeb-7ab7c677c7a7",
"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-09-13T20:24:21.9263774+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6106e036-326d-44ae-af14-28bc31925494",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c5bd60e-448f-4840-892d-0c103923be12",
"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": "503a5821-c3c5-4606-b861-847d84de2684",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b6f3baa6-8e9c-4ebb-b48e-6818ec308ac8"
},
"suggested_date_start": "2026-09-13T20:24:21.9263774+00:00",
"skill_id": "0d0e5023-8acd-4c6b-9076-f5531dae4ac2",
"skill_code": "sample string 32",
"skill": {
"id": "bfc38968-a3c8-4044-95da-a8b18a05ac51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ebf566d0-682a-4ede-b4b4-b3b7546858f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae04fc34-0ff6-4fbb-bf00-8f00fa40d400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ef10412-3bca-41e1-bdca-a8a05bba5f51",
"db_currency_id": "5e539c61-e988-4bfb-9fbd-79d464fe0119",
"db_language_id": "c2b9a0bd-8c75-47e3-a3e6-b0ebdc261e6e",
"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-09-13T20:24:21.9263774+00:00"
},
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "85d96dcd-6ec5-4693-aaf0-2e3e7fd46824",
"date_reported_by_company": "2026-09-13T20:24:21.9263774+00:00",
"id2": 36,
"company_id": "3b182583-914b-4c7b-bdfc-080066a3d93d",
"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": "e07dccee-15e4-4077-bf63-86123560eab3",
"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-09-13T20:24:21.9263774+00:00"
},
"work_instruction_details_id": "b4a0e18b-41fb-4942-987f-87c1d06224b0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b19a4c3-8ea7-40e3-a1bb-3ce59350e45f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "445de55a-db5f-4ba1-8b1e-ce55aaba21e7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-13T20:24:21.9263774+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": "8391979e-5c12-4bed-8d14-acfd209ccba7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-13T20:24:21.9263774+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.