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": "55f8c754-0bda-42b6-a072-04542b548841",
"jobs_id": "3bccf22f-120e-4871-a929-ceacda74bfa9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b2a5220e-eb0e-4b1a-aa65-f272537e8758",
"_parent_id": "14f38611-cf47-44d9-afe8-9453f7d09155",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7192a697-9e5d-43f7-a160-470f7a3664dd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f814dcc8-7646-45aa-969c-418763f203d4",
"_parent_id": "9248f605-f7b0-421b-8ad0-4c86c5848f2b",
"root_parent_id": "4da4f6d3-2ec1-479f-b209-7ed04a6429ef",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fd6024d9-08b3-427c-a9e3-d6ca6fe05cd1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2f27312b-8876-4171-a701-77859f603baf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "545c5ad2-c123-4ef8-90e2-56b108a370db",
"_parent_code": "sample string 6",
"sales_organization_id": "f9992e08-8e7c-47a3-9f48-91de5a6b2f63",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"equipment_model_id": "45f36d23-281a-484b-a53e-ebf73d268fc5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "13ab870e-0b21-4723-8702-1f89e296be6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c0f4f634-19ea-4bcd-af32-f5ac59acd3ce",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "228b78f1-3386-4e1a-bbf3-9e1712b9ca92",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6e399821-bdac-489a-971e-cf9adf8170d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"equipment_family_id": "f7e71368-9302-4065-b9dd-df3c54842216",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2f27312b-8876-4171-a701-77859f603baf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "545c5ad2-c123-4ef8-90e2-56b108a370db",
"_parent_code": "sample string 6",
"sales_organization_id": "f9992e08-8e7c-47a3-9f48-91de5a6b2f63",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"date_in_production_since": "2026-06-08T22:43:10.9151272+00:00",
"date_out_of_production_since": "2026-06-08T22:43:10.9151272+00:00",
"date_end_support": "2026-06-08T22:43:10.9151272+00:00",
"sales_organization_id": "d062ac51-5aac-4648-8da9-b6948c4b0437",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+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-06-08T22:43:10.9151272+00:00"
},
"project_status_id": "99a040b0-8852-4714-a353-86e752433604",
"project_status_code": "sample string 10",
"project_status": {
"id": "b752c261-b71f-470e-9f97-7ba5a735e198",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c09e5ba-f642-49d3-b08c-11c39e9760bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"company_id": "29bbb9c2-b727-4de6-804b-d4e26e84385f",
"company_code": "sample string 12",
"db_address_id": "07af9482-a5a5-487c-8555-7c46a757810b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "34018dcd-e949-48de-97ee-dc0a04704d43",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ba0b77a6-a41b-4428-bdeb-c9002d82b3dd",
"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-06-08T22:43:10.9151272+00:00",
"date_create": "2026-06-08T22:43:10.9151272+00:00",
"date_update": "2026-06-08T22:43:10.9151272+00:00",
"updated_by_user_id": "54267d83-5295-49b9-a922-d3c0f3582bb9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-08T22:43:10.9151272+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-06-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-08T22:43:10.9151272+00:00",
"date_last_job": "2026-06-08T22:43:10.9151272+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-08T22:43:10.9151272+00:00",
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00",
"is_mobile_installation": true
},
"job_type_id": "45ad84be-7ddd-4b48-93ea-c14bae29f2a9",
"job_type_code": "sample string 7",
"job_type": {
"id": "b06781fd-893c-404c-918d-c1791ce26eb0",
"name": "sample string 2",
"sales_organization_id": "beeb0d3d-176e-4ec4-a29f-1068ba487352",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00",
"code": "sample string 7"
},
"job_priority_id": "1e00135e-681e-4e5d-bf95-cf26541ab649",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "598f73d9-dcfd-4a48-aef1-42b75a9ffad5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "57df484b-f4d1-447a-a73a-eaab6c45ac41",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"job_status_id": "55f97c76-f678-493c-88b0-f7b338742958",
"job_status_code": "sample string 11",
"db_address_id": "dbdf6f8c-a81c-4872-917c-9de09bc1a09a",
"contact_id": "57a569d6-3deb-415e-85fe-e15a6d08c28a",
"requested_by_company_id": "0f965d88-96c9-4a88-a417-5cee30ae56bb",
"requested_by_contact_id": "dd3fa83c-4a36-4b71-b3f6-74ae007b319c",
"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-06-08T22:43:10.9151272+00:00",
"due_date": "2026-06-08T22:43:10.9151272+00:00",
"date_create": "2026-06-08T22:43:10.9151272+00:00",
"date_update": "2026-06-08T22:43:10.9151272+00:00",
"date_closed": "2026-06-08T22:43:10.9151272+00:00",
"suggested_user_id": "16188d80-46c8-422a-ba18-e2bea703b12e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "80b125a5-509b-4eb1-a2b2-ae782aba44f5",
"db_language_id": "307116ee-e671-4eae-b25e-29681c1513f3",
"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-06-08T22:43:10.9151272+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "30c161ba-10d6-46f8-9142-eea8b89ea7c3",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9e07fb44-031c-4b16-869c-f662181bf2de",
"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": "44a31175-279a-4c44-9e68-db7d0c1a28ad",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f2b9c470-3bee-4867-98dd-04530e980e1b"
},
"suggested_date_start": "2026-06-08T22:43:10.9151272+00:00",
"skill_id": "a6369574-359f-4c86-b8d0-191b4b62b24e",
"skill_code": "sample string 32",
"skill": {
"id": "8522db87-02a3-4bf5-9899-45bc85fbc60a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ee078d00-ebcd-4e21-bbb4-0cc5710d5015",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07ce95c9-9059-4411-9e56-d193a65dc951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5bc56a3-fbe9-4729-8854-e8bd6232c6f7",
"db_currency_id": "f9ef8149-7f5a-4219-83bf-e4a1750c94f5",
"db_language_id": "ccd331a8-3869-4685-ad1d-c267a90c4839",
"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-06-08T22:43:10.9151272+00:00"
},
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "efcd70ed-04ad-46d9-acb0-5f1e3de59949",
"date_reported_by_company": "2026-06-08T22:43:10.9151272+00:00",
"id2": 36,
"company_id": "9eaef795-dc9d-4a04-aaad-53586509193e",
"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": "ace8b2dc-1095-4514-a48b-006a9ba7cc75",
"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-06-08T22:43:10.9151272+00:00"
},
"work_instruction_details_id": "c3e95a01-29d6-4e1e-84f8-e5b460720814",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b26bdcc5-bb84-45b8-ac39-3d78ccb63497",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8bd0eb8d-eb5d-4be9-980f-4969b4fe8c23",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-08T22:43:10.9151272+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": "f43f758a-ab01-4c83-9404-c70c9a1d99a3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-08T22:43:10.9151272+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.