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": "753453df-8882-4c72-ab56-0ad2d9cb3a20",
"jobs_id": "503ecdb0-d323-41c1-9080-70d72d4081d5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "149f8096-23eb-4e7d-9c08-2235b25166ec",
"_parent_id": "4939ba1c-3986-4561-a133-f2c635640743",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "42ed251d-e403-4aa4-b84c-99b31d7f9091",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ddc4f528-11db-42bb-920a-79a8747cf0e5",
"_parent_id": "fec4af86-642f-423a-bc26-be294f188445",
"root_parent_id": "e996df1b-2158-4689-8e90-f268fe2045ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "874496ad-f4e5-44ae-b1c2-d8dd8438fd78",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "feac573a-3d98-4268-b167-468331e6b667",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e52b5df-b9f3-4505-984a-423c5274ce12",
"_parent_code": "sample string 6",
"sales_organization_id": "4483eec6-ce1e-454a-83b4-cfd8887f19af",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"modified_dateutc": "2025-11-28T13:51:44.9265077+00:00"
},
"equipment_model_id": "28fd2c4a-ce1d-45d7-a31d-eee6aabae876",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db674005-6731-4ec1-a468-c831dd29d0f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b81d536f-bd1b-4430-9b03-c71398e53b44",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "59be69c8-4549-461b-b5e5-9d63f6722e92",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d03f2935-5c42-4a83-8beb-16f470828577",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"modified_dateutc": "2025-11-28T13:51:44.9265077+00:00"
},
"equipment_family_id": "60d34e5c-b8c2-4a1a-a876-3a9e12172915",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "feac573a-3d98-4268-b167-468331e6b667",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e52b5df-b9f3-4505-984a-423c5274ce12",
"_parent_code": "sample string 6",
"sales_organization_id": "4483eec6-ce1e-454a-83b4-cfd8887f19af",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"modified_dateutc": "2025-11-28T13:51:44.9265077+00:00"
},
"date_in_production_since": "2025-11-28T13:51:44.9265077+00:00",
"date_out_of_production_since": "2025-11-28T13:51:44.9265077+00:00",
"date_end_support": "2025-11-28T13:51:44.9265077+00:00",
"sales_organization_id": "ff3c7fff-712f-41a3-8df2-5bbdf55d3474",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+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-28T13:51:44.9421286+00:00"
},
"project_status_id": "c4c73501-d22e-4ecc-accd-f6be9ab6e3ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ce70795-1165-4c66-8b02-2375f6c01991",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e2b0c0a7-3085-4f15-a618-71a5d107bed5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00"
},
"company_id": "03ef4706-de41-4084-a28e-ca1c20e5ac19",
"company_code": "sample string 12",
"db_address_id": "5b12efac-fabd-4b1f-99cb-1f9c763b7d85",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "900fb197-cfc2-4381-aabd-4c760a9f4aca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb8360b5-4854-4299-97f7-1b0eca98b913",
"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-28T13:51:44.9421286+00:00",
"date_create": "2025-11-28T13:51:44.9421286+00:00",
"date_update": "2025-11-28T13:51:44.9421286+00:00",
"updated_by_user_id": "fb80a11a-a362-4ada-98c3-5649f2edb7f0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T13:51:44.9421286+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T13:51:44.9421286+00:00",
"date_last_job": "2025-11-28T13:51:44.9421286+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T13:51:44.9421286+00:00",
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00",
"is_mobile_installation": true
},
"job_type_id": "d862669a-b84f-4515-829c-573f8fdb0a4b",
"job_type_code": "sample string 7",
"job_type": {
"id": "98b9b2c8-2077-47f9-8c8d-bf3ea216c085",
"name": "sample string 2",
"sales_organization_id": "b6817cca-4f7a-4bea-bfd0-60dbaaf349a6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00",
"code": "sample string 7"
},
"job_priority_id": "52e9774c-1c03-4ef9-a2bb-1cbeaba71767",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a04b8e7e-9cd0-4b2d-9a93-68488255fde9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9af781c9-92e2-4405-a7c4-fd5e54454174",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00"
},
"job_status_id": "1c4c0599-d50f-4151-b655-1f29d7e114f4",
"job_status_code": "sample string 11",
"db_address_id": "f6afa2fe-aef9-4e7b-8485-2c4e1edcf218",
"contact_id": "a241e347-dd22-45b3-b544-f04a9a4872e8",
"requested_by_company_id": "23af215e-2a2a-42cf-beb8-49d0f508a181",
"requested_by_contact_id": "cec859dc-dac3-4a22-93e2-33be900c71d1",
"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-28T13:51:44.9421286+00:00",
"due_date": "2025-11-28T13:51:44.9421286+00:00",
"date_create": "2025-11-28T13:51:44.9421286+00:00",
"date_update": "2025-11-28T13:51:44.9421286+00:00",
"date_closed": "2025-11-28T13:51:44.9421286+00:00",
"suggested_user_id": "f652dbd7-4dfd-4465-9ba1-59919bb9828b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a84a1c42-7b55-43a8-bddd-1054a2deda14",
"db_language_id": "848f6a94-fbd5-42c8-a96f-65df2bf2c9bb",
"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-28T13:51:44.9421286+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f795395f-9a54-4ded-b517-b2562e02fd3c",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea579eae-8eae-421f-9ea9-74b688af358a",
"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": "db397245-57d3-4fdd-9fd6-f5c82fdb6c2f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e861d068-e632-4694-8fd4-e95852d76742"
},
"suggested_date_start": "2025-11-28T13:51:44.9421286+00:00",
"skill_id": "fb34b825-f658-442c-9588-a6e77c50a5d6",
"skill_code": "sample string 32",
"skill": {
"id": "26d55f91-84bd-461e-ab13-e568df3bbe0f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eeda17ec-55d6-42bd-a20c-d1d5d879034c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6a1753b-f113-4a5b-9e78-4a37f250285d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a770f67d-7152-4341-aafa-095bdb9d57e9",
"db_currency_id": "2aad74f3-bbb1-45f2-9f81-736217e02105",
"db_language_id": "8e49ba8b-cb59-45cf-a7f3-5fadfe3e0406",
"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-28T13:51:44.9265077+00:00"
},
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fe98eaa7-4b61-4d79-a14e-ec3edf7e11b8",
"date_reported_by_company": "2025-11-28T13:51:44.9421286+00:00",
"id2": 36,
"company_id": "15b01217-ee64-485b-b9ae-ac1febec4c99",
"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": "71a671b6-258a-488d-9ca0-a893420d7720",
"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-28T13:51:44.9421286+00:00"
},
"work_instruction_details_id": "8c60db84-dcf8-4a27-a24d-8465a5bea1d3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8dd267e4-0a15-4dff-98b6-fb589cfb373f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cb9508b9-b6fb-4b24-b364-88504c1cc162",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T13:51:44.9421286+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": "4ebeacff-a9e7-469d-9ae3-b0a2d83c1b3f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T13:51:44.9421286+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.