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": "d710bee8-4b98-4b80-b1c9-6c6b67c0e1e0",
"jobs_id": "0ed78351-a3e1-4ab7-87bc-95daa20fd225",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cba3f49d-c37b-4422-9c26-b4fbc6b6bae4",
"_parent_id": "55506caa-c274-45f2-993b-d979058c02b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c8869709-7142-4bac-a5cf-ffe20c2632bc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3a9cd67-875e-4c82-b71b-00d24e10ca28",
"_parent_id": "0028440a-4300-41a6-ae3d-559945d21584",
"root_parent_id": "ce704b12-b86e-47e3-aa5a-43dc544d1557",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fa12ffd4-ba44-496d-80a4-fe60b80c9b04",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0df7d4bf-0cb1-4557-90e0-4d86cd902876",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab0724f7-2230-4823-b227-e31b7094f7c6",
"_parent_code": "sample string 6",
"sales_organization_id": "51277fb9-6aec-4e82-bd6b-d5a53e00a5dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"equipment_model_id": "0ba8f652-15ee-448f-ae4b-2c49330ab21f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5f57f150-7c9f-4b45-96ba-dc338510a6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2fe2b92b-bd3c-4c4e-ade1-a3a50c7bb4f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6bae9988-0ddf-4e32-a428-84d48cdcf86a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f8eb1417-213e-4824-8d7b-108de96a5020",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"equipment_family_id": "467988cc-833a-4298-864a-c2f0fe4fe20b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0df7d4bf-0cb1-4557-90e0-4d86cd902876",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab0724f7-2230-4823-b227-e31b7094f7c6",
"_parent_code": "sample string 6",
"sales_organization_id": "51277fb9-6aec-4e82-bd6b-d5a53e00a5dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"date_in_production_since": "2026-01-07T13:47:52.1665591+00:00",
"date_out_of_production_since": "2026-01-07T13:47:52.1665591+00:00",
"date_end_support": "2026-01-07T13:47:52.1665591+00:00",
"sales_organization_id": "a0f0f837-6c81-4e29-9a2a-bfe271fe1f79",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+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-01-07T13:47:52.1665591+00:00"
},
"project_status_id": "0fd5203b-0f11-4225-89f8-fb124ad45513",
"project_status_code": "sample string 10",
"project_status": {
"id": "dfc3d186-0431-400a-b790-a00e91a64f25",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "098c4d07-9628-4c94-9246-450e854de6b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"company_id": "e662ba3f-6bd8-4d26-b5e5-75631ff95d5e",
"company_code": "sample string 12",
"db_address_id": "9636c9db-b9ae-4fc9-be69-45dfe39e7a6a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fcd75498-cdf2-42f2-95ea-5fb09509cfcf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4628ee55-d964-49c8-ad47-e54b884951e8",
"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-01-07T13:47:52.1665591+00:00",
"date_create": "2026-01-07T13:47:52.1665591+00:00",
"date_update": "2026-01-07T13:47:52.1665591+00:00",
"updated_by_user_id": "1ab0a6af-f773-4f40-9fc4-8952e8e1cd71",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T13:47:52.1665591+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T13:47:52.1665591+00:00",
"date_last_job": "2026-01-07T13:47:52.1665591+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T13:47:52.1665591+00:00",
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00",
"is_mobile_installation": true
},
"job_type_id": "9be825eb-1e00-40b0-8f57-e89162e95518",
"job_type_code": "sample string 7",
"job_type": {
"id": "e31598de-e2d2-42dd-9fd8-14a190555eba",
"name": "sample string 2",
"sales_organization_id": "4fa1f67e-42b8-4b01-8e87-0506ae2f410d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00",
"code": "sample string 7"
},
"job_priority_id": "001291e2-2f97-47c0-bbca-7ae8270f7dae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b1ae1c2f-c476-46d9-8611-d0096888b41f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fe0059e5-4515-4de8-9653-386a3f322d87",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"job_status_id": "c054cbb4-a7e4-461b-acab-8527f077e909",
"job_status_code": "sample string 11",
"db_address_id": "c0e0dd83-c377-4998-ac5f-29d09aef69a9",
"contact_id": "2a69e93f-6876-42cc-bdf7-0c9872168639",
"requested_by_company_id": "5937ac07-602c-4d8a-a7bb-d6b927b8b424",
"requested_by_contact_id": "5633275a-c31f-4686-b405-2972eedcf42c",
"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-01-07T13:47:52.1665591+00:00",
"due_date": "2026-01-07T13:47:52.1665591+00:00",
"date_create": "2026-01-07T13:47:52.1665591+00:00",
"date_update": "2026-01-07T13:47:52.1665591+00:00",
"date_closed": "2026-01-07T13:47:52.1665591+00:00",
"suggested_user_id": "12921bd8-3127-4ab6-8e9e-e429d9023c6a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7827a04d-31e5-4f97-ac4a-9bac0a502af1",
"db_language_id": "c2dae99e-85fd-45fa-b5cb-9842433346cc",
"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-01-07T13:47:52.1665591+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5ecd8e9a-9747-46e1-9603-b20d963239d2",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8f20ce7-8275-4984-b9d8-fa188c006511",
"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": "e0eb29c6-d289-46aa-9382-b83c37df7d69",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "689dddfa-3cf5-4be1-8143-a7ed4c2099ed"
},
"suggested_date_start": "2026-01-07T13:47:52.1665591+00:00",
"skill_id": "0be41cd4-71d2-48cf-bd9e-2a22dfc0195a",
"skill_code": "sample string 32",
"skill": {
"id": "b014be1d-3e1c-4ec3-8f1f-ab3c6afc7dc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5069d2cd-f2dc-4035-b8c9-afbcd601cbbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdba0059-f5e2-4b32-a05c-f3484721f46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b175dc69-cf35-473e-86f4-b7b647483077",
"db_currency_id": "66909019-abd6-48a7-b03f-7fb729dfaeec",
"db_language_id": "d3206db6-b021-4322-9a2b-842989526dea",
"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-01-07T13:47:52.1665591+00:00"
},
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4af47edc-f41e-429d-ad9a-d249aa458915",
"date_reported_by_company": "2026-01-07T13:47:52.1665591+00:00",
"id2": 36,
"company_id": "58c79a66-9d5f-4df7-b325-6e7a099ea542",
"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": "3b9246b1-edbb-417c-afc4-1a40ca6933c8",
"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-01-07T13:47:52.1665591+00:00"
},
"work_instruction_details_id": "82e1b2e1-821e-4cda-b560-82a56dc7ce29",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8dca08d1-dff3-4a86-bd01-d482c1d39a84",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5abbabb7-ee04-47f4-a090-a4b06d2290f3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T13:47:52.1665591+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": "5efd45f5-8a74-4eac-8c70-2cb160354555",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T13:47:52.1665591+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.