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": "207bb57e-91d0-4134-99d5-ce82aa1c50a7",
"jobs_id": "3d773ccf-bc24-48ec-ab25-cdfd436ced9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d4941c5-c94e-4c03-8e95-ee3d6bcedc58",
"_parent_id": "d8f90ba9-5faf-4df0-97f8-070005d2239c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e9caed73-4c8b-47d5-8bbf-3730315b8c94",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b41ccb79-3ebc-4319-a2b9-486e23e755bf",
"_parent_id": "2e341614-93d1-4ff2-ba50-1dc04fb7de10",
"root_parent_id": "44c04977-b5ab-4abc-ac14-1a2a352e3c43",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e18db8ff-b7a7-4262-8c3f-7c8a899d818f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8fc329ab-6b0f-478e-ba8d-585370e46440",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6e33fd9-92e1-4987-9b9a-7183563a7498",
"_parent_code": "sample string 6",
"sales_organization_id": "f701afec-20c6-4249-9a5b-99ea19953d0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"equipment_model_id": "60a4a540-9ff0-49f7-9733-249518818c2d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e254883a-3204-4573-9398-a63b0a87dffd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ae26fec9-a31c-4247-9d16-14ea7e1abc44",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ff231c14-d154-4920-b3cc-617d707ffe51",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "98860c57-4528-4c5e-8b58-4e9a0bab0473",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"equipment_family_id": "773b3dbb-22dc-4cd3-83fb-d9e035da0c55",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8fc329ab-6b0f-478e-ba8d-585370e46440",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6e33fd9-92e1-4987-9b9a-7183563a7498",
"_parent_code": "sample string 6",
"sales_organization_id": "f701afec-20c6-4249-9a5b-99ea19953d0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"date_in_production_since": "2026-08-21T21:59:58.9586362+00:00",
"date_out_of_production_since": "2026-08-21T21:59:58.9586362+00:00",
"date_end_support": "2026-08-21T21:59:58.9586362+00:00",
"sales_organization_id": "768d9c9d-152c-4e12-b209-9bef9539560e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+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-08-21T21:59:58.9586362+00:00"
},
"project_status_id": "170c2893-6fc2-45a5-b793-4a04c542f7ef",
"project_status_code": "sample string 10",
"project_status": {
"id": "254207a5-cca7-48f6-a34b-838101c88678",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cf380c88-6f61-4d27-8ea4-65aaa7e65a01",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"company_id": "e1f46c4f-7a50-4bb2-9023-53eb36243d94",
"company_code": "sample string 12",
"db_address_id": "e8312ea7-6dce-4e32-ace1-2b727453f8a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5c2e1667-c184-4e83-bc4b-5adc736c978f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "28255b52-6a8b-4450-9e13-50112c4c9e15",
"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-08-21T21:59:58.9586362+00:00",
"date_create": "2026-08-21T21:59:58.9586362+00:00",
"date_update": "2026-08-21T21:59:58.9586362+00:00",
"updated_by_user_id": "19cf5124-0a8d-4312-b0f2-b07d2fcdc197",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T21:59:58.9586362+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T21:59:58.9586362+00:00",
"date_last_job": "2026-08-21T21:59:58.9586362+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T21:59:58.9586362+00:00",
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00",
"is_mobile_installation": true
},
"job_type_id": "32b44218-1a55-48ce-a1be-4f7d41756f0b",
"job_type_code": "sample string 7",
"job_type": {
"id": "d8d8ba97-13a3-4ff1-850b-a008695b1023",
"name": "sample string 2",
"sales_organization_id": "80230e72-8920-4e05-804a-93714dcae6df",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00",
"code": "sample string 7"
},
"job_priority_id": "27d48636-156c-480b-af08-15f656b12b17",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fde77a36-db94-4e76-8d66-2d36a0f1345a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "15550638-2e52-4271-9966-404814ed0c46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"job_status_id": "00f3d4a7-2267-4da2-9bfc-4d37b0f13f72",
"job_status_code": "sample string 11",
"db_address_id": "dfe052b6-47de-4400-94d7-78694b24a59f",
"contact_id": "0ed121fe-266f-4410-b573-7682535c6072",
"requested_by_company_id": "ac62facd-e139-47f3-81cf-4e33ccd3ade3",
"requested_by_contact_id": "efda5579-8373-4235-9127-51cfbd89193f",
"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-08-21T21:59:58.9586362+00:00",
"due_date": "2026-08-21T21:59:58.9586362+00:00",
"date_create": "2026-08-21T21:59:58.9586362+00:00",
"date_update": "2026-08-21T21:59:58.9586362+00:00",
"date_closed": "2026-08-21T21:59:58.9586362+00:00",
"suggested_user_id": "7e91aa91-b40f-4f47-9a26-ae478f8a0ed2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1a3d420d-aafb-46f9-8f96-129bf1051794",
"db_language_id": "d757b9e2-d1a2-47f9-b9cc-0ce617d2dc52",
"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-08-21T21:59:58.9586362+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "602aa0fb-b2a9-443c-8517-5f58ebb2291c",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "361412af-a583-4b8e-83d6-2eacf6683908",
"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": "a44353d5-bdc6-4a95-bcaf-c457cbc89bdb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d22d3c22-0b36-44c9-abfc-44cd5d7e2f26"
},
"suggested_date_start": "2026-08-21T21:59:58.9586362+00:00",
"skill_id": "f3c12301-7ca7-4c0e-93f9-8718d75a5fce",
"skill_code": "sample string 32",
"skill": {
"id": "4b15e0f2-115d-4ba1-82d4-08e3038d04a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b1dab5a-6742-4bb7-852e-82c360692f07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f74660e3-f455-40bf-9d7d-fcd621bef2c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e628ac-b93f-46f2-907e-3e4e9681194e",
"db_currency_id": "c6a8a2cf-d491-4c3a-b9b5-46efed4c91e9",
"db_language_id": "960b46af-dc95-4d9d-af34-3a7e55cf3a59",
"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-08-21T21:59:58.9586362+00:00"
},
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "82de0d49-1144-4756-be3d-e13aaa1b76fc",
"date_reported_by_company": "2026-08-21T21:59:58.9586362+00:00",
"id2": 36,
"company_id": "52a52d29-5f3d-4df1-9660-845162a2b50a",
"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": "a22483d4-6e9c-4eba-b4a3-e49e3fb6076c",
"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-08-21T21:59:58.9586362+00:00"
},
"work_instruction_details_id": "cdaf0410-318b-4f12-8e51-4eda61ca44cb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7856602e-25c5-4aef-8855-16470825fb20",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e4c3a679-7f28-4e8d-8857-c27cf4ca6c3e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T21:59:58.9586362+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": "3c38300b-64ab-4387-a8d4-224569eabebf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T21:59:58.9586362+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.