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": "dbd95de6-c3d1-4306-8b03-7b8a7eaf4ccb",
"jobs_id": "1a8227e6-2776-47a7-8c6a-fc0bb0a5a52f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a233fdee-a8fb-4770-b99e-26f60e94de07",
"_parent_id": "4b4dd2c0-2156-4564-8a61-1c1547d60c4a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e667899-130a-43dd-b568-33d30cf16167",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4b0d09ef-e011-4e50-8024-35056ea1e806",
"_parent_id": "53317bf2-6ca4-41df-a788-a00651dc1606",
"root_parent_id": "d17b1cdd-add7-4fda-936f-45b835cdb7c7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c81f280f-44bf-4410-97b4-907bf4826981",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a7a1ec62-42a7-4858-a47b-3dc2bcffade1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab2b8d23-d3bb-4f5b-8671-a4f03e952510",
"_parent_code": "sample string 6",
"sales_organization_id": "81934c53-6dd4-42cf-982b-ed5ec65b777c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"modified_dateutc": "2026-10-05T15:55:30.2511024+00:00"
},
"equipment_model_id": "cc98d3f5-2457-4eca-9c7c-d03292658881",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a303cabc-b119-47d6-81a0-59bf68c35385",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4c07ce10-60d8-45df-8dff-0577ff5da41c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f8fd34c5-a050-431f-8afc-b37810d79f4c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db860300-142c-46ad-a96e-ba5adcc2ad4d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"modified_dateutc": "2026-10-05T15:55:30.2668428+00:00"
},
"equipment_family_id": "28ff8ea7-db21-4cf6-bab1-5c2d49e2504c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a7a1ec62-42a7-4858-a47b-3dc2bcffade1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab2b8d23-d3bb-4f5b-8671-a4f03e952510",
"_parent_code": "sample string 6",
"sales_organization_id": "81934c53-6dd4-42cf-982b-ed5ec65b777c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"modified_dateutc": "2026-10-05T15:55:30.2511024+00:00"
},
"date_in_production_since": "2026-10-05T15:55:30.2668428+00:00",
"date_out_of_production_since": "2026-10-05T15:55:30.2668428+00:00",
"date_end_support": "2026-10-05T15:55:30.2668428+00:00",
"sales_organization_id": "25791d0c-a01e-4df2-90b9-ec02fa0cfc98",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+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-10-05T15:55:30.2668428+00:00"
},
"project_status_id": "12d456be-56ef-4470-b54a-05918234f42f",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c06e2c4-6e29-40ca-95d8-de1b8b6874b2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "02afa511-f16f-4844-ac75-b9e7854e80de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T15:55:30.2668428+00:00"
},
"company_id": "3d1cefaa-6b46-41b8-bcc2-06a1f8f3e975",
"company_code": "sample string 12",
"db_address_id": "8a3bace7-7049-45b1-9459-ba7eaa37bcd8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "30a11ec9-6dd1-4bba-8f49-6c157d985181",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "37f15ff3-93bc-47fd-b135-765f1835ec70",
"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-10-05T15:55:30.2668428+00:00",
"date_create": "2026-10-05T15:55:30.2668428+00:00",
"date_update": "2026-10-05T15:55:30.2668428+00:00",
"updated_by_user_id": "403a2fdf-c893-4116-aec1-079550698ab2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T15:55:30.2668428+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-10-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T15:55:30.2668428+00:00",
"date_last_job": "2026-10-05T15:55:30.2668428+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T15:55:30.2668428+00:00",
"modified_dateutc": "2026-10-05T15:55:30.2668428+00:00",
"is_mobile_installation": true
},
"job_type_id": "1bdf9d3e-4c5c-4702-9967-4c9a393be6f3",
"job_type_code": "sample string 7",
"job_type": {
"id": "9a6d0476-54cf-469f-a005-fd32625bc0d1",
"name": "sample string 2",
"sales_organization_id": "fad6e369-1b67-482c-bf8c-5ec475b1a824",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T15:55:30.2668428+00:00",
"code": "sample string 7"
},
"job_priority_id": "f55609b2-53bc-489d-bd4e-a9cbf80f34c8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7bb324c5-63b4-4f84-87ea-242673d0bde5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "514374ef-3b34-4d14-9c52-c974db097ec1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T15:55:30.2823727+00:00"
},
"job_status_id": "b071adac-303a-4941-9df8-f359c6b5d0cb",
"job_status_code": "sample string 11",
"db_address_id": "4d230d9e-a0a7-4bf1-8184-55deb94b44b8",
"contact_id": "2d48d746-31a3-411c-9cbe-3d9cb22a9978",
"requested_by_company_id": "46799968-e8a6-4af0-84f7-972d7ab43729",
"requested_by_contact_id": "00e05910-1304-4da2-953f-ac0cc577eb61",
"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-10-05T15:55:30.2823727+00:00",
"due_date": "2026-10-05T15:55:30.2823727+00:00",
"date_create": "2026-10-05T15:55:30.2823727+00:00",
"date_update": "2026-10-05T15:55:30.2823727+00:00",
"date_closed": "2026-10-05T15:55:30.2823727+00:00",
"suggested_user_id": "4120bff5-2ce6-4c08-9ba9-0c684803e570",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ac3c3775-dd99-439a-bebd-d913b39cc9a7",
"db_language_id": "dfabf490-d5b3-4000-a931-4745c2b4874b",
"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-10-05T15:55:30.2823727+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2a17a23a-c9b7-4eb0-a1a1-7094f0938a39",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "871c7568-e879-421b-a296-639745661d96",
"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": "29595ff1-a877-4993-89d3-3dbd4cb8d6b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T15:55:30.2823727+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b05e764b-2c39-4aca-9ad4-beb234a69f3e"
},
"suggested_date_start": "2026-10-05T15:55:30.2823727+00:00",
"skill_id": "3ffa5f56-8ac6-4690-b7aa-58e1dccb307b",
"skill_code": "sample string 32",
"skill": {
"id": "4e30079c-d3e1-4b90-a55d-d6cf56201b73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "455d05e9-20ed-4e79-b8ad-f1c1b6eef202",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "578d1062-0ff5-4db5-8ab0-bf1a44eec84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5ec21e-bce9-41b2-b1b7-6d9f70382272",
"db_currency_id": "4662f07b-2ce3-4606-912c-4d819ba92760",
"db_language_id": "23784990-de49-43d1-9e61-6d9570c1c1f4",
"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-10-05T15:55:30.2511024+00:00"
},
"modified_dateutc": "2026-10-05T15:55:30.2823727+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5382855c-3208-4002-950e-94fea3d3d21e",
"date_reported_by_company": "2026-10-05T15:55:30.2823727+00:00",
"id2": 36,
"company_id": "206b71e2-1707-4b6d-a2ea-124b6f14a60e",
"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": "6177d468-b569-455e-9d85-cae1631acc4f",
"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-10-05T15:55:30.2823727+00:00"
},
"work_instruction_details_id": "63f2a703-eed7-4915-8574-b534e19d0455",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8fadbb69-19e1-4e27-96d6-69fcb46ae1e9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ac8d6c2-65e2-40b2-8bcb-e679d2889f44",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T15:55:30.2823727+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": "d657b903-88f3-418d-885d-e7af93f8e89e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T15:55:30.2979836+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.