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": "2a644a44-74d8-4523-ac3a-4da060324121",
"jobs_id": "584bc639-aeb1-4e10-a7c7-127ff38267d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8e8fc181-b961-4543-acc5-8dc9d23d9ed0",
"_parent_id": "10da0e35-a82d-4390-83ce-da814073549c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4179ef59-b296-415a-afaf-8d1326dfff56",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6080834a-c582-4e38-ac1f-ed3a10a89e7a",
"_parent_id": "170b55a9-053d-4223-b503-9a94afeb9b6a",
"root_parent_id": "c53a0f44-d393-4eb7-94db-963e22aceef9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bc48d31a-f827-45e7-8790-671c7e1f898f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8864c51e-ca29-47c8-b6c0-73aac46b5844",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a200374a-7700-4d06-a258-0652be1bf355",
"_parent_code": "sample string 6",
"sales_organization_id": "0343e207-5d29-48e2-bd1f-948d1e12f13b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"equipment_model_id": "d65094df-2a88-48d3-ae85-5cc868324deb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "215c05bb-e5d9-4b5b-882a-a6f6aca9e231",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "23c71271-66a5-4d1a-8b94-45582fec6866",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b54e2c30-84fa-4f25-b8b6-0b3be4855d8e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6a11ac07-013f-4e43-bfae-91315389a1f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"equipment_family_id": "24d57268-66ad-4471-bb51-5f7dc6ad6904",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8864c51e-ca29-47c8-b6c0-73aac46b5844",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a200374a-7700-4d06-a258-0652be1bf355",
"_parent_code": "sample string 6",
"sales_organization_id": "0343e207-5d29-48e2-bd1f-948d1e12f13b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"date_in_production_since": "2026-06-26T20:14:29.8790758+00:00",
"date_out_of_production_since": "2026-06-26T20:14:29.8790758+00:00",
"date_end_support": "2026-06-26T20:14:29.8790758+00:00",
"sales_organization_id": "9d8f7b62-80b4-4faa-83d7-3bbbef791d95",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+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-06-26T20:14:29.8790758+00:00"
},
"project_status_id": "fa60168e-3bc9-44a6-a97b-6069214d72f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "05c3ff58-39e0-4e66-8e83-a48cbcdf7c72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65cff83c-2d52-49c7-86ee-9a5c4dc50a68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"company_id": "a766af76-27db-44bb-aee6-70d045a358fb",
"company_code": "sample string 12",
"db_address_id": "5ee9818f-1b7c-44b0-b97a-cc12b1691f46",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c3e30854-2170-4e4c-825e-c7dce0f7139d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d6451d16-647f-47ce-afb2-6d7fb6119d88",
"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-06-26T20:14:29.8790758+00:00",
"date_create": "2026-06-26T20:14:29.8790758+00:00",
"date_update": "2026-06-26T20:14:29.8790758+00:00",
"updated_by_user_id": "e55c42b3-a157-4ee4-b580-5ce8d5b85c96",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-26T20:14:29.8790758+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-26T20:14:29.8790758+00:00",
"date_last_job": "2026-06-26T20:14:29.8790758+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-26T20:14:29.8790758+00:00",
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00",
"is_mobile_installation": true
},
"job_type_id": "1112e721-1f54-40e3-b0f7-a036d1c0542a",
"job_type_code": "sample string 7",
"job_type": {
"id": "2ba86009-3dcb-4006-921b-c8603ae68641",
"name": "sample string 2",
"sales_organization_id": "cdcca2d9-5478-4c79-8e75-7e588175acca",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00",
"code": "sample string 7"
},
"job_priority_id": "2aa57338-dcf6-4b3d-ad49-dbb799824626",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d0ea2da6-4a94-4c5e-9279-e422bde7484d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4e5e4a02-47b4-4137-8d88-9dbe25acda7a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"job_status_id": "2c8418a7-9606-42fa-980e-06f428bfd31f",
"job_status_code": "sample string 11",
"db_address_id": "65e6490e-1458-48d6-8a5a-3aaf513407cb",
"contact_id": "89bf99cd-6add-4814-b588-204fe910e31c",
"requested_by_company_id": "858be8c8-0a44-4a9d-bc66-e3f829225ca9",
"requested_by_contact_id": "89e82ee8-5185-4d93-bb8e-280a9fd77613",
"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-06-26T20:14:29.8790758+00:00",
"due_date": "2026-06-26T20:14:29.8790758+00:00",
"date_create": "2026-06-26T20:14:29.8790758+00:00",
"date_update": "2026-06-26T20:14:29.8790758+00:00",
"date_closed": "2026-06-26T20:14:29.8790758+00:00",
"suggested_user_id": "94cda806-58b3-4c25-876d-139f5077fbd9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "62dd6709-0c2d-41b7-a1ea-68a9ddf31467",
"db_language_id": "4de0b510-5672-4794-b07b-295ae1f87af7",
"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-06-26T20:14:29.8790758+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1a22fd0d-0bf6-407c-ab86-7dc5b477271a",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a9823b05-cd68-4156-a180-5bab8a9fa87f",
"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": "6b90e288-2ecb-4162-b021-b3e15d0e5c93",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "741a17be-a5b0-4179-9909-0634eb6289ed"
},
"suggested_date_start": "2026-06-26T20:14:29.8790758+00:00",
"skill_id": "86d08409-f792-4900-8f79-d7c3f1d92835",
"skill_code": "sample string 32",
"skill": {
"id": "c3d95f01-c495-45b6-a030-fed25987adaa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "df7a3111-b1f4-4534-aea0-afd275293d8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2374c240-a084-4ab9-815d-04e4283e8ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec4854e1-0a0e-45af-b92c-2096a6a53334",
"db_currency_id": "7b54e455-cb9b-4f5b-bfd7-2b3795068ffd",
"db_language_id": "121852d3-ebd0-4a21-b7d9-8eb66818821e",
"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-06-26T20:14:29.8790758+00:00"
},
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3850bff1-d9da-4588-9a6c-865582c03356",
"date_reported_by_company": "2026-06-26T20:14:29.8790758+00:00",
"id2": 36,
"company_id": "3fa1b41a-320c-40bf-b74b-067191097cbd",
"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": "daf8ec27-bd96-4d5e-8143-f8655a236b96",
"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-06-26T20:14:29.8790758+00:00"
},
"work_instruction_details_id": "63d5a6b4-69f1-4608-bc2e-90aea6af7383",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "378a6dac-402f-4315-b98d-a137df0d794e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dc7a5bee-ac24-41ac-8746-54aba496b83a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-26T20:14:29.8790758+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": "34b037de-74db-4495-97ef-d3b7b4480c6b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-26T20:14:29.8790758+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.