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": "802c28e2-99c6-498f-9a19-971e9ccb686e",
"jobs_id": "5342f068-b18f-4ca4-9d77-bf067a15e94d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6805333b-d86a-4ff9-bd26-e71476309b65",
"_parent_id": "484df1fc-8501-4439-81ab-60bbf0bfe3e5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dc66828d-b342-4959-bb39-8ff80f812414",
"project_reference_back_office": "sample string 5",
"project": {
"id": "baf09048-d086-4bcc-b105-f6e78ff6581e",
"_parent_id": "4affb8a0-8bec-44c1-874f-3c2e946a7ed6",
"root_parent_id": "7c25dbf3-a5f9-4a7e-a05a-81b89770ce82",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76787cd3-aeb1-4545-8d7f-730fb7b5d1bb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6a2b79ce-ee41-46e0-8ef8-b3caea0f690e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1fe5c64-df95-4252-a632-b743ef1c0ec4",
"_parent_code": "sample string 6",
"sales_organization_id": "bef3ae66-6d49-42e0-bffb-82f94e5e4842",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"equipment_model_id": "9b2b182a-80a5-4c2f-ac59-9d0ad399cb53",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2f784d2d-3fa0-4f7d-be40-16a616d83a1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "12d41a54-b3a0-4a86-91e1-43009033e3d1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b75ef90a-8259-4baa-a73a-4b2a67c4f0f6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fe3c9f7c-7132-40d6-ba86-9d99dccdde8b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"equipment_family_id": "e526b25e-7d0f-48fd-b773-ff63a5ebda4d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6a2b79ce-ee41-46e0-8ef8-b3caea0f690e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1fe5c64-df95-4252-a632-b743ef1c0ec4",
"_parent_code": "sample string 6",
"sales_organization_id": "bef3ae66-6d49-42e0-bffb-82f94e5e4842",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"date_in_production_since": "2025-10-07T02:38:26.8950141+00:00",
"date_out_of_production_since": "2025-10-07T02:38:26.8950141+00:00",
"date_end_support": "2025-10-07T02:38:26.8950141+00:00",
"sales_organization_id": "1822ee1b-bb70-4b7b-adb0-a3f8d52685c8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+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-10-07T02:38:26.8950141+00:00"
},
"project_status_id": "65c5d772-95af-4176-ab23-e2392109430c",
"project_status_code": "sample string 10",
"project_status": {
"id": "76211afc-d494-496b-9de8-ea81338be288",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "eec27e57-e78b-45f6-b626-b44e3d65e1ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"company_id": "9c574353-f308-4d1c-8ff6-33a24b54fd12",
"company_code": "sample string 12",
"db_address_id": "428ca902-9a61-4a3d-8923-353509a317a1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "40aca9b3-33c1-405b-bb7b-322c0f6b32d4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "02d097d6-02a4-47e6-9375-c9e480997c38",
"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-10-07T02:38:26.8950141+00:00",
"date_create": "2025-10-07T02:38:26.8950141+00:00",
"date_update": "2025-10-07T02:38:26.8950141+00:00",
"updated_by_user_id": "fdb3f944-7443-4fe7-9048-7e764f9b6d66",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-07T02:38:26.8950141+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-10-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-07T02:38:26.8950141+00:00",
"date_last_job": "2025-10-07T02:38:26.8950141+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-07T02:38:26.8950141+00:00",
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00",
"is_mobile_installation": true
},
"job_type_id": "6bf3cbf6-2f6b-4da8-ae23-fc240f7c0af5",
"job_type_code": "sample string 7",
"job_type": {
"id": "334edb95-2f67-42a3-b387-d5cba755c9eb",
"name": "sample string 2",
"sales_organization_id": "f82b76d2-02df-4337-b9d0-f4ebb3778f1c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00",
"code": "sample string 7"
},
"job_priority_id": "bac5512b-bac7-43cd-acd0-1cbdd0233057",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4c619301-ee47-4d8c-8c60-e316d69278b8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b52061e-a07b-4340-b816-5c86d3ed3cfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"job_status_id": "ef508e70-f819-4056-a5b3-a5a163989b79",
"job_status_code": "sample string 11",
"db_address_id": "655ac0fd-5407-453b-8f63-dc448bef1708",
"contact_id": "f4d14edb-e34c-4f0c-be70-743485e02a69",
"requested_by_company_id": "97ef84ce-ac7c-4554-8c96-6049f24f5fba",
"requested_by_contact_id": "7623584a-61f9-446e-8b99-12942c581e99",
"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-10-07T02:38:26.8950141+00:00",
"due_date": "2025-10-07T02:38:26.8950141+00:00",
"date_create": "2025-10-07T02:38:26.8950141+00:00",
"date_update": "2025-10-07T02:38:26.8950141+00:00",
"date_closed": "2025-10-07T02:38:26.8950141+00:00",
"suggested_user_id": "04cda24e-7875-4252-af1c-f0d191937c6f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b55bbb90-7ce0-4361-bbee-b6a17235bc88",
"db_language_id": "aceb3c93-d1e1-4711-b2c7-4abd123b158d",
"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-10-07T02:38:26.8950141+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "020bb5f8-2fdb-431e-ac43-e4c4cce17630",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3ef60e8e-6743-4ea6-ab5f-6a9a8896a8d8",
"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": "b2414d6b-3dca-493d-b352-d33358b9380d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8b94aa5-9664-4a28-a02c-94d4ea9eeb52"
},
"suggested_date_start": "2025-10-07T02:38:26.8950141+00:00",
"skill_id": "c81a6ce5-3377-4152-b777-b363eb9e76f2",
"skill_code": "sample string 32",
"skill": {
"id": "c4f25989-d15f-4739-8266-6ebc0f090be7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8e7b8e6e-1e72-40b0-9b1f-88882dde4c89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6748f4f0-71ae-4462-8e40-0d55ef5df42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37cf8ebd-6373-4486-a443-fcf5743f7ac4",
"db_currency_id": "7bf40381-4f64-43b9-82e2-05d44147fae8",
"db_language_id": "99a4ea42-58b2-4c0a-866d-a97c58a1c767",
"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-10-07T02:38:26.8793913+00:00"
},
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "de048109-2e5a-4909-9060-7e2d4545788f",
"date_reported_by_company": "2025-10-07T02:38:26.8950141+00:00",
"id2": 36,
"company_id": "84f7387e-b983-45bf-bc71-df8f616990cb",
"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": "5dd09024-4d06-46c6-945a-769dce913be6",
"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-10-07T02:38:26.8950141+00:00"
},
"work_instruction_details_id": "305c08ba-bde7-4e65-bad4-93c42519f9fa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "00fcc8b0-de1c-411b-9f7c-99a77e07b1ab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0be3801-5827-4a37-8a9f-706ad4d1b4a4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-07T02:38:26.8950141+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": "f852dff1-34bb-437a-bb65-510b2287b005",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-07T02:38:26.8950141+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.