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": "f907de79-d7a7-453e-bb91-ccdcf04180ea",
"jobs_id": "bf60cd5d-09c4-40b8-a47d-27b108e2ac96",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "457aead9-630f-4a0e-b73e-2b169c112e54",
"_parent_id": "6d53c6e2-c097-4bb2-9843-57046cb60ce9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bba77509-488f-4ef3-bcc5-88764caf6f1b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b74b30c-e3b9-4c37-9541-a5c493120708",
"_parent_id": "3f1ee1ac-febd-4405-a1cb-bdd980d57e57",
"root_parent_id": "ad9339ae-d577-404e-aa86-53715868aecf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ca8f3129-866f-49dd-9b20-eeeaa0158200",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7365d05c-d491-44f4-bf41-dc64572cef57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71fcca20-aa85-498d-9dfa-a3fa825fbf17",
"_parent_code": "sample string 6",
"sales_organization_id": "498f112a-1276-4233-b6c0-30f44c791a4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00"
},
"equipment_model_id": "2a87035d-4aeb-4288-96b2-412f192b6cdd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0bc1d99a-6301-4ef4-bd44-d962c69f640c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0e511138-e9b1-497a-8dae-e3c9998b9579",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e4404bd4-9be9-4bbd-9233-00e63a7f35a1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8920039d-031a-4eb0-a272-57580f36f67b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00"
},
"equipment_family_id": "7daf9c16-9614-4a40-a0ff-7cb8ebace8d8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7365d05c-d491-44f4-bf41-dc64572cef57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71fcca20-aa85-498d-9dfa-a3fa825fbf17",
"_parent_code": "sample string 6",
"sales_organization_id": "498f112a-1276-4233-b6c0-30f44c791a4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00"
},
"date_in_production_since": "2025-12-12T00:00:05.4763375+00:00",
"date_out_of_production_since": "2025-12-12T00:00:05.4763375+00:00",
"date_end_support": "2025-12-12T00:00:05.4763375+00:00",
"sales_organization_id": "cc305d29-57c5-47d7-a107-6366a2a8c4ac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+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-12-12T00:00:05.4763375+00:00"
},
"project_status_id": "3afd6fcb-9cb0-4405-bd29-e6a7d809cc30",
"project_status_code": "sample string 10",
"project_status": {
"id": "0a410d23-9916-4052-8f7b-97ae5025501d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7d8d37d7-d478-4039-a10d-367c84132f70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00"
},
"company_id": "9e703383-c75e-4c90-97b1-6dc66e6d6077",
"company_code": "sample string 12",
"db_address_id": "7337db1d-7bd9-4453-a5d0-2f57e4972399",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5da7822a-f166-4826-9986-00b3a501065f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "46f1579b-87b3-4935-9943-615787c6808f",
"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-12-12T00:00:05.4763375+00:00",
"date_create": "2025-12-12T00:00:05.4763375+00:00",
"date_update": "2025-12-12T00:00:05.4763375+00:00",
"updated_by_user_id": "ce2bd32e-12cf-4255-8cd5-91dd1e1f9561",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-12T00:00:05.4763375+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-12-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-12T00:00:05.4763375+00:00",
"date_last_job": "2025-12-12T00:00:05.4763375+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-12T00:00:05.4763375+00:00",
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00",
"is_mobile_installation": true
},
"job_type_id": "1c8bc8c7-1bce-4c54-add2-b3e5d4b5d66c",
"job_type_code": "sample string 7",
"job_type": {
"id": "712fc3e1-e08b-49b0-9b8f-5ea82138c52b",
"name": "sample string 2",
"sales_organization_id": "13423f14-d0f4-469a-a1b7-466b86b93314",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00",
"code": "sample string 7"
},
"job_priority_id": "dc711ebd-6f1e-41ef-a201-a2e653edaf05",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8093e438-c09a-44bb-a717-8a72faa46911",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ba11b897-aa07-41e4-ad11-05b4ba3410b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-12T00:00:05.4763375+00:00"
},
"job_status_id": "95f8adf3-6d6d-4244-9894-3adc82fa9af3",
"job_status_code": "sample string 11",
"db_address_id": "561b33be-54e0-4581-8e25-0197050dda2a",
"contact_id": "a2bf693e-5698-423e-ace6-e812fdfa8108",
"requested_by_company_id": "2f07d4de-406a-4ab6-88a7-7ecd6b673c58",
"requested_by_contact_id": "ba77d394-7ba2-4da5-8577-3c3e05854f4e",
"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-12-12T00:00:05.4763375+00:00",
"due_date": "2025-12-12T00:00:05.4763375+00:00",
"date_create": "2025-12-12T00:00:05.4763375+00:00",
"date_update": "2025-12-12T00:00:05.4763375+00:00",
"date_closed": "2025-12-12T00:00:05.4763375+00:00",
"suggested_user_id": "8b7d821b-d3f3-4fd5-8c80-6526165ea24d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aac8379d-bab5-426d-b306-2fd6c5ab8214",
"db_language_id": "37f0ffef-f47d-438a-b262-d5968166f4b8",
"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-12-12T00:00:05.4763375+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fbbe7759-ce30-4bc9-887a-7b4d347ce9ff",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dba86b9e-d0f1-40d5-a6ed-ff88c1d08789",
"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": "d1d38faf-964c-4579-b52f-5c3533ee999d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-12T00:00:05.4919616+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce5f9ab8-627d-4e3e-99d6-7e050ee156b8"
},
"suggested_date_start": "2025-12-12T00:00:05.4919616+00:00",
"skill_id": "91d298e9-5299-4475-b4c4-5811ccb324fa",
"skill_code": "sample string 32",
"skill": {
"id": "196ed9d9-06df-4060-b84b-ea81159980fa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5671b8c5-7129-47cb-968c-5ad183af0f3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8bad70b-0f81-4ce2-8e28-57d8728eb3d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f9878be-5773-48c4-b4b5-de66ba7ee652",
"db_currency_id": "9bb7d5c7-f5ff-4ae2-9797-4e0aece4e028",
"db_language_id": "d3effca9-e364-49e0-8404-37339453f780",
"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-12-12T00:00:05.4763375+00:00"
},
"modified_dateutc": "2025-12-12T00:00:05.4919616+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "37f1b615-da1d-4266-b443-f58555c706e6",
"date_reported_by_company": "2025-12-12T00:00:05.4919616+00:00",
"id2": 36,
"company_id": "4124fab2-9f2d-4b38-84ea-34706bc03320",
"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": "06800ce4-c232-459d-8b50-68a1da324c2d",
"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-12-12T00:00:05.4919616+00:00"
},
"work_instruction_details_id": "09323a34-a5a3-475a-8f47-3caf737448bb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "44d0db12-881b-4aa5-8123-f2c6f85dc65c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e9bf3a49-f1f1-4105-918c-0b0e537a6aa3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-12T00:00:05.4919616+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": "100871de-5960-4063-9409-ebe1f95cd4f8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-12T00:00:05.4919616+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.