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": "d39f1788-a33d-4aca-8cbd-32942c77223b",
"jobs_id": "c424f81c-f59f-4262-8be0-4aef2c33bb0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61aedaeb-c9dd-4657-bbc2-e4f0080cbac2",
"_parent_id": "493e9b15-5c02-4c90-8b26-0d5f4eb75fd9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f1e81c84-8160-4081-b80f-ea88ce4d2743",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bc495495-98b9-48ff-a6e7-53bd27ecf489",
"_parent_id": "8dd1b0bd-6336-4287-8941-70a9e3fe6199",
"root_parent_id": "703e5bd5-5718-4cc7-9405-62cb4e5a1512",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "16d50f7a-5e26-4482-ac25-da736e748b91",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "19c6fb2b-9871-456a-a98c-862aa56aa1fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0dd63f6-7604-4483-89a9-057c84126abb",
"_parent_code": "sample string 6",
"sales_organization_id": "20d7b77e-bdea-42b5-a5aa-2720b6033027",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"modified_dateutc": "2025-11-15T08:16:40.9293687+00:00"
},
"equipment_model_id": "3b19f170-661a-4508-96b2-b3476b18a57d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "22ceda50-80d3-439e-8934-3504c17fd310",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2d23a0d3-60e9-4af7-aa07-82af087a9eeb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "460f3ead-50cd-4dbf-b692-17b82f501eea",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "523912c0-a257-4e06-af4e-6cfeb90111be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"modified_dateutc": "2025-11-15T08:16:40.9293687+00:00"
},
"equipment_family_id": "f2f4d30b-4c77-46c1-9e36-249be7189092",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "19c6fb2b-9871-456a-a98c-862aa56aa1fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0dd63f6-7604-4483-89a9-057c84126abb",
"_parent_code": "sample string 6",
"sales_organization_id": "20d7b77e-bdea-42b5-a5aa-2720b6033027",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"modified_dateutc": "2025-11-15T08:16:40.9293687+00:00"
},
"date_in_production_since": "2025-11-15T08:16:40.9293687+00:00",
"date_out_of_production_since": "2025-11-15T08:16:40.9293687+00:00",
"date_end_support": "2025-11-15T08:16:40.9293687+00:00",
"sales_organization_id": "100ca5d7-9979-4cda-98c7-8a6da6f9e73e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+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-11-15T08:16:40.9448764+00:00"
},
"project_status_id": "891c9e50-5977-472a-b949-d66cb9d7438f",
"project_status_code": "sample string 10",
"project_status": {
"id": "19289312-5f20-40ef-9861-9eca009bd069",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "982f9c3c-b673-4155-b841-436ca2c39f13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00"
},
"company_id": "e553279b-7053-45e6-bdb0-00787ec41fcc",
"company_code": "sample string 12",
"db_address_id": "6263d579-3556-4529-b9c7-936ff0e4792d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "14f890e1-e23e-4731-a9f4-dd432aa609dc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3930e19d-5641-42d0-81f7-3cdc9053fa21",
"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-11-15T08:16:40.9448764+00:00",
"date_create": "2025-11-15T08:16:40.9448764+00:00",
"date_update": "2025-11-15T08:16:40.9448764+00:00",
"updated_by_user_id": "ffeeba86-1025-4475-acae-750bcf2602aa",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-15T08:16:40.9448764+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-11-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-15T08:16:40.9448764+00:00",
"date_last_job": "2025-11-15T08:16:40.9448764+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-15T08:16:40.9448764+00:00",
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00",
"is_mobile_installation": true
},
"job_type_id": "59c35cf9-c6c0-4fd7-bda5-98f0dfa14c33",
"job_type_code": "sample string 7",
"job_type": {
"id": "c6f323e4-ebb5-4904-8cae-de586613ed33",
"name": "sample string 2",
"sales_organization_id": "b767d0c5-62c1-409f-b6a3-f4b5da43955f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00",
"code": "sample string 7"
},
"job_priority_id": "c5d340ba-5543-4d29-a5f0-77c1ffa795de",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "46e97a6c-2cd1-4451-8f77-a83ec1d20d5e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "11b9684f-fabc-4727-a214-36e5d1f3c384",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00"
},
"job_status_id": "3499e65d-6bae-4bfe-b8ce-549e9c3c0017",
"job_status_code": "sample string 11",
"db_address_id": "de51ef54-23b6-4cc2-8993-cf5996b9d0e9",
"contact_id": "e479d40c-0bb2-44d6-9245-d6605fcf8ac8",
"requested_by_company_id": "6323fe0f-3541-48ce-b841-1a289cb17fa2",
"requested_by_contact_id": "7a36dbe0-eeea-4035-ba48-b1bcc8ee202f",
"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-11-15T08:16:40.9448764+00:00",
"due_date": "2025-11-15T08:16:40.9448764+00:00",
"date_create": "2025-11-15T08:16:40.9448764+00:00",
"date_update": "2025-11-15T08:16:40.9448764+00:00",
"date_closed": "2025-11-15T08:16:40.9448764+00:00",
"suggested_user_id": "761071b6-fdd5-4976-af26-8bae674588b4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f9093c38-eceb-4fd2-8449-ba4e86d1baa0",
"db_language_id": "7ab9b35d-eff3-4757-b896-21a3638955a8",
"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-11-15T08:16:40.9448764+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4b8a515b-f89a-42b0-ad10-be549b57ef1f",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e32b897b-07f4-44e3-b215-c23990258915",
"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": "f692e2fe-fbde-4ec3-944c-3ca95dc6a03e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24546af3-8b4f-42de-9b4a-99b782890fc1"
},
"suggested_date_start": "2025-11-15T08:16:40.9448764+00:00",
"skill_id": "f270cd02-c8a6-43aa-8248-6c5afccf4333",
"skill_code": "sample string 32",
"skill": {
"id": "644320ec-0bdc-43c8-9a02-b092a3e6f568",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "80411725-96a9-462e-819e-7ce8d1c18bdf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e874eb7f-83a1-4656-8c46-e0744a0e2993",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a971d3f-f6df-43bc-b3f2-425e1b2359b2",
"db_currency_id": "535637bb-2ceb-4176-8119-580a5dd925a6",
"db_language_id": "faedd08b-458e-43c1-a4eb-1391fb625a9d",
"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-11-15T08:16:40.9293687+00:00"
},
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "05bb4090-4250-43f4-9b4e-315652603e67",
"date_reported_by_company": "2025-11-15T08:16:40.9448764+00:00",
"id2": 36,
"company_id": "0b4a0e2a-00d6-4872-b03d-e0e65be62d9e",
"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": "677448d4-ba50-4dbe-9f2a-d7e625b93cd3",
"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-11-15T08:16:40.9448764+00:00"
},
"work_instruction_details_id": "81daeb24-566e-41a8-b521-b06b18be3b19",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "082ba099-a432-43f4-bdcb-3484200adceb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27133149-be72-4163-9215-81dbb384d54f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-15T08:16:40.9448764+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": "9b16107e-8902-4897-8c2b-283771c54ea6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-15T08:16:40.9448764+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.