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": "173b0009-6a6c-4154-b4ca-f90cd34eeace",
"jobs_id": "8ae89a38-2492-4ae9-a95a-393a656d2194",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ca50c85-0c1f-4de0-bae7-c6af7b3ce882",
"_parent_id": "bc079de4-0166-49b5-b348-b549768bd701",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0580dd30-05ee-4844-ad6a-7593602b8499",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d2d191e6-f061-4075-9686-081fa2ba0db1",
"_parent_id": "945aa5e3-c9be-4816-9e57-c9c1e17e2316",
"root_parent_id": "1829ab82-f7bd-4d2d-9025-671008158734",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4938b202-d296-4057-ac86-e52f91cf6c79",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "219b7637-8762-4a6f-9b6f-3429ead3c000",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6839eee-d800-4746-8c98-1e082791ed27",
"_parent_code": "sample string 6",
"sales_organization_id": "4cb2b098-f1ad-446e-ae90-2d079a9d141f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"equipment_model_id": "daa0cf8c-4023-46f0-915f-799c905af06c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "59464373-5a02-414e-af10-16474ed86f85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fc6f2317-fb68-4fb1-bb02-b35c8bfc2744",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f51bf138-72b7-4f50-b0d1-0393f3bee533",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "636caaf6-fd57-4c9c-96c5-cb4699dbc1d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"equipment_family_id": "9af6311f-3dc7-42b8-8c9a-d13c16bd3a4d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "219b7637-8762-4a6f-9b6f-3429ead3c000",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6839eee-d800-4746-8c98-1e082791ed27",
"_parent_code": "sample string 6",
"sales_organization_id": "4cb2b098-f1ad-446e-ae90-2d079a9d141f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"date_in_production_since": "2026-09-13T08:20:07.1803833+00:00",
"date_out_of_production_since": "2026-09-13T08:20:07.1803833+00:00",
"date_end_support": "2026-09-13T08:20:07.1803833+00:00",
"sales_organization_id": "b238beb7-2f74-4f75-9b3e-a3936e3ed749",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+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-09-13T08:20:07.1803833+00:00"
},
"project_status_id": "b2c7fe6a-292b-4da2-814c-113424975251",
"project_status_code": "sample string 10",
"project_status": {
"id": "0477eefa-73c5-419b-a0b5-c767baaac012",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "69909def-4064-4403-b8fb-0e49095b5e5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"company_id": "3ffbe4ae-2409-4738-aca2-dfb448544084",
"company_code": "sample string 12",
"db_address_id": "430ccb39-f804-4f35-ae0a-4d250f763f95",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b8a82316-5557-4fa5-a3ee-72f25b81c6d8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e4c3a3da-2a76-47ef-ac17-d3276acd9ff1",
"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-09-13T08:20:07.1803833+00:00",
"date_create": "2026-09-13T08:20:07.1803833+00:00",
"date_update": "2026-09-13T08:20:07.1803833+00:00",
"updated_by_user_id": "2c876be4-4fd0-4314-986d-df8ea99317d9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-13T08:20:07.1803833+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-09-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-13T08:20:07.1803833+00:00",
"date_last_job": "2026-09-13T08:20:07.1803833+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-13T08:20:07.1803833+00:00",
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00",
"is_mobile_installation": true
},
"job_type_id": "a49a1414-c131-49c7-a416-cbf34cd29d3e",
"job_type_code": "sample string 7",
"job_type": {
"id": "f7047970-1f2b-4108-8254-6fe787c8f958",
"name": "sample string 2",
"sales_organization_id": "10d770bc-616b-4811-9144-72707d958df2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00",
"code": "sample string 7"
},
"job_priority_id": "4c680d3d-ad40-4d8e-b75a-ff21427804bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "594ae252-6f5a-4a86-87ee-62b1270a9fa9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ffad0d25-69ae-47ba-b9c5-7d07929350de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"job_status_id": "f2c684b8-81ea-4384-b236-cf0b6f5377ca",
"job_status_code": "sample string 11",
"db_address_id": "c52c2967-5908-4ac7-9347-1ccd36c2c8b8",
"contact_id": "fb568b3a-b893-4617-b154-b08df162ef5a",
"requested_by_company_id": "b8346303-295a-4b39-b5be-d5548d3ef634",
"requested_by_contact_id": "14fdfff1-7e58-4bb3-a1bf-8a821e6b8ebd",
"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-09-13T08:20:07.1803833+00:00",
"due_date": "2026-09-13T08:20:07.1803833+00:00",
"date_create": "2026-09-13T08:20:07.1803833+00:00",
"date_update": "2026-09-13T08:20:07.1803833+00:00",
"date_closed": "2026-09-13T08:20:07.1803833+00:00",
"suggested_user_id": "01666589-2923-4b38-98eb-5711c31bc0b1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e528b0ee-d143-42e3-9a07-be0aebdcd24d",
"db_language_id": "55d6d132-92c4-47eb-8b8b-04e7621c9fed",
"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-09-13T08:20:07.1803833+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f7549934-7b12-438d-9fc5-8ea075d69e36",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "af2e900e-e161-42bc-a62f-683fde05712c",
"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": "dd79f047-6ab7-4700-a950-a9a5ee393329",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27780fd7-bb0e-4899-909d-775aa2c1e079"
},
"suggested_date_start": "2026-09-13T08:20:07.1803833+00:00",
"skill_id": "d67429c6-7865-49c8-948f-7e646fc9be51",
"skill_code": "sample string 32",
"skill": {
"id": "0c548c64-8bef-4448-9b03-666d83de5940",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "16005165-73df-4602-9fa4-0b20f0aa296f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78f6ef2d-94a9-4672-87b3-e711f5e2f1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e50568-dcec-4d23-b9d3-c3825ba79ab7",
"db_currency_id": "0a2ffe3a-a39b-46e7-8117-87e096e0e33e",
"db_language_id": "d70b33f1-ecb4-4bdd-97f3-8e12d97e3836",
"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-09-13T08:20:07.1803833+00:00"
},
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c3e1cd7a-9d64-4d18-bc23-27aef61007c8",
"date_reported_by_company": "2026-09-13T08:20:07.1803833+00:00",
"id2": 36,
"company_id": "9b068151-96e8-4e9d-a55d-753b34a9e9fe",
"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": "ff8e28ac-de48-400f-a7c8-e1bded6b6165",
"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-09-13T08:20:07.1803833+00:00"
},
"work_instruction_details_id": "2a8f4184-369c-4cb1-b017-5edf1d3a39ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b8268096-612e-4117-973a-fca191521c33",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b63e0ef6-7401-4fa7-bd9d-d2bd0c8bde4e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-13T08:20:07.1803833+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": "ed5b6825-0f84-48eb-aaf6-17578422422e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-13T08:20:07.1803833+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.