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": "3af0be24-157a-4975-acb3-a4e5d61b2416",
"jobs_id": "0e35d0f0-6663-4ea7-a145-9e187f198243",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "715b2957-df24-42a9-9b63-c60c66a03e1a",
"_parent_id": "dc52c289-ac93-4206-8b2d-d9f48c99ad3c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0125224a-02e8-4c3d-892f-a2c53d2183d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "06e7bc8b-b8aa-4ac3-93bc-01ef41fbb938",
"_parent_id": "8a098d23-206b-4db5-a0a5-ad0e896d7c46",
"root_parent_id": "b4085e8c-385a-4e84-a4b9-8e06fd614217",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "467738fa-00db-43ae-9fc9-dc3517d781dc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6f9ce519-97f7-4b4f-abf2-62c84d3b58ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "735e658b-2062-4422-88f8-30165b8bb200",
"_parent_code": "sample string 6",
"sales_organization_id": "46ff8400-73d1-411c-aef2-5401b95df289",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"equipment_model_id": "fadcbb49-b494-415f-984b-7ca98abd01c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ebe2d7cb-8e1d-4dbc-9343-006a960849b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1edab7ed-d7b1-4d75-998d-21641e05b123",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7c7fec3c-638c-4e2e-951c-82d0e45b6923",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "48fbba9d-8986-4f4f-9a7a-335536c8c720",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"equipment_family_id": "93537a58-b82c-4bc1-a1f4-c02ecff1fdcc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6f9ce519-97f7-4b4f-abf2-62c84d3b58ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "735e658b-2062-4422-88f8-30165b8bb200",
"_parent_code": "sample string 6",
"sales_organization_id": "46ff8400-73d1-411c-aef2-5401b95df289",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"date_in_production_since": "2026-05-24T12:52:33.3880643+00:00",
"date_out_of_production_since": "2026-05-24T12:52:33.3880643+00:00",
"date_end_support": "2026-05-24T12:52:33.3880643+00:00",
"sales_organization_id": "1ac65724-f188-4136-b40f-a8805d639bcc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+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-05-24T12:52:33.3880643+00:00"
},
"project_status_id": "33e31205-4b49-4fcb-a7ae-39b7e0b1b537",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c44ef1a-8979-450c-8d4b-650de04b3ebf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c4cd37a8-487f-45aa-9ea9-d8dc6bc90c43",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"company_id": "6999a0aa-7bb5-484a-a9c0-4736ff5cd775",
"company_code": "sample string 12",
"db_address_id": "9511cb10-b376-4154-9b1a-4ac3d31a125d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "da66d3bd-2c6a-486f-a532-590a05bfe025",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9a8cfe73-c7b3-473b-b250-9556344b719f",
"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-05-24T12:52:33.3880643+00:00",
"date_create": "2026-05-24T12:52:33.3880643+00:00",
"date_update": "2026-05-24T12:52:33.3880643+00:00",
"updated_by_user_id": "58220637-dc57-435d-82e0-4c9999e1a407",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-24T12:52:33.3880643+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-05-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-24T12:52:33.3880643+00:00",
"date_last_job": "2026-05-24T12:52:33.3880643+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-24T12:52:33.3880643+00:00",
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00",
"is_mobile_installation": true
},
"job_type_id": "29e06aa7-bc8f-4ef8-bbf2-a8e8b58d2105",
"job_type_code": "sample string 7",
"job_type": {
"id": "b329d510-057c-4d1d-a24a-95d9755f3ea1",
"name": "sample string 2",
"sales_organization_id": "be052791-43bb-44d8-a69a-3863862bf66e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00",
"code": "sample string 7"
},
"job_priority_id": "ddae6534-9ee2-4f45-b92a-abc44a568197",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "114bf099-4abd-44e0-8c4c-f61966f99367",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d72da307-d850-46f3-8377-70402cc60427",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"job_status_id": "1cfce30d-3ab1-4578-82cb-fbc03763aaca",
"job_status_code": "sample string 11",
"db_address_id": "8edfbd2f-286c-434a-89e5-01f441cdd824",
"contact_id": "906c53c7-2913-4aad-ab70-7732ef3d935c",
"requested_by_company_id": "3c83a79e-0778-47ec-b88e-df9c0c87a240",
"requested_by_contact_id": "2e03e7b7-5d31-486f-8771-5a231f4a90b1",
"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-05-24T12:52:33.3880643+00:00",
"due_date": "2026-05-24T12:52:33.3880643+00:00",
"date_create": "2026-05-24T12:52:33.3880643+00:00",
"date_update": "2026-05-24T12:52:33.3880643+00:00",
"date_closed": "2026-05-24T12:52:33.3880643+00:00",
"suggested_user_id": "850aa10f-a24d-42da-a51a-2303d246a530",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c8c866ce-e948-47e0-83e5-ab68102907e0",
"db_language_id": "e827a5c8-1466-484d-bed7-ebf4ea3c6d71",
"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-05-24T12:52:33.3880643+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "824abb14-5505-4e6e-a50c-c2e32ebe1937",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "937ef620-2703-4db7-b87e-9781258ecb0b",
"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": "bf0a6f00-0087-4a96-884d-10b71d61c6e6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f0a23ef7-4b0e-4655-a4a7-2d8edc19a49d"
},
"suggested_date_start": "2026-05-24T12:52:33.3880643+00:00",
"skill_id": "8ae12732-db12-47f3-b73a-d1ae17697a6e",
"skill_code": "sample string 32",
"skill": {
"id": "22689dfb-ba02-4124-92f7-5e3bdeaf4df4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e557064e-b88b-49ae-af44-4af002b641de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c76a693-66fa-4b97-a85c-820944ddf46b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6651334-d224-40a7-b10e-c47b5cd204e3",
"db_currency_id": "51cf7c0e-cd34-4fce-acd1-82137cdda26d",
"db_language_id": "581914d2-47a0-4f5d-85d2-a8d74eb9660f",
"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-05-24T12:52:33.3880643+00:00"
},
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f9e114d-9a2a-47cd-9fa0-960b583fe64c",
"date_reported_by_company": "2026-05-24T12:52:33.3880643+00:00",
"id2": 36,
"company_id": "b5dc499b-b9b0-4225-a3cc-e3387ce40f78",
"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": "269bea0c-4a56-47df-8b01-a7dd1899b8b5",
"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-05-24T12:52:33.3880643+00:00"
},
"work_instruction_details_id": "da8a4a0b-695e-4417-b100-e7807642fd1b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1216f157-c61e-4b8d-a665-4fbdbdebc604",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1ed1838a-c6ad-4938-8021-860b3ea99b6f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-24T12:52:33.3880643+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": "2e70c0c7-10a2-4789-a308-4eae3b6c32c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-24T12:52:33.3880643+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.