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": "f19edc78-648b-4e6e-b09a-35f7c156232d",
"jobs_id": "0c41cc4e-e0f9-498e-a36d-6b62ac90324a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8b6346c7-8dfc-4aa3-873c-a0735937505f",
"_parent_id": "230e2ed6-4c40-4cd9-be15-ffdad349d2e1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4d2f652-872f-4790-a579-e3ff8aed2c19",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04176068-e303-4da3-8f57-1cf647132afb",
"_parent_id": "a4e026c4-9b32-43bc-ab19-96452bc5ba17",
"root_parent_id": "4d80969e-4f9a-4cd4-9557-d89af3d42283",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f4845093-4a40-4bbd-b84c-8f5534f116b3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e938e6a6-818b-4ef5-8f5f-8b07e08bc449",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "676c73d7-ad5b-45c4-aa73-edd31e54cb5e",
"_parent_code": "sample string 6",
"sales_organization_id": "9806576b-59c9-4ecf-b04f-7647a90ebaa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"modified_dateutc": "2026-02-18T02:55:35.6330222+00:00"
},
"equipment_model_id": "41d38506-53be-46c8-ba91-6c40654329e9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2c87c8e9-b830-4290-b349-57ee5af83989",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7c4cdc72-cdf7-4a3b-977c-8b53aa8bf0f2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "341430a6-c0e1-47c3-8289-882304d7b731",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f385a9fe-5d3f-4f35-b4de-f7c5140ed70b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"modified_dateutc": "2026-02-18T02:55:35.6330222+00:00"
},
"equipment_family_id": "e9a9b7ca-7359-40cc-b8de-c8c9147b75f0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e938e6a6-818b-4ef5-8f5f-8b07e08bc449",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "676c73d7-ad5b-45c4-aa73-edd31e54cb5e",
"_parent_code": "sample string 6",
"sales_organization_id": "9806576b-59c9-4ecf-b04f-7647a90ebaa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"modified_dateutc": "2026-02-18T02:55:35.6330222+00:00"
},
"date_in_production_since": "2026-02-18T02:55:35.6330222+00:00",
"date_out_of_production_since": "2026-02-18T02:55:35.6330222+00:00",
"date_end_support": "2026-02-18T02:55:35.6330222+00:00",
"sales_organization_id": "49d0120f-1d69-46db-aa5c-2ab949c0142e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+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-02-18T02:55:35.6486475+00:00"
},
"project_status_id": "1c128c6a-8051-4c8e-9589-81c600dbf60f",
"project_status_code": "sample string 10",
"project_status": {
"id": "589f8c64-7aeb-4e64-9bc5-8eadc97ad6c1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "971c00bd-b5cc-4213-92ca-f66c2bd1aebd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00"
},
"company_id": "b055d1f2-e52f-4494-8a1a-7b26aabd5b9e",
"company_code": "sample string 12",
"db_address_id": "01e5fb74-d1e4-4d08-8d2b-c6d91a8669ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e2e24f3-ea16-474d-8d2a-bf087e18b2cd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "148ba9a7-9a47-4c53-997c-186698f45c2a",
"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-02-18T02:55:35.6486475+00:00",
"date_create": "2026-02-18T02:55:35.6486475+00:00",
"date_update": "2026-02-18T02:55:35.6486475+00:00",
"updated_by_user_id": "2b1c7c09-82c6-4b49-900d-fe50380e99b0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T02:55:35.6486475+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T02:55:35.6486475+00:00",
"date_last_job": "2026-02-18T02:55:35.6486475+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T02:55:35.6486475+00:00",
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00",
"is_mobile_installation": true
},
"job_type_id": "b7aa3cc4-8ec5-45c4-8188-c3a46c3c6802",
"job_type_code": "sample string 7",
"job_type": {
"id": "98b41350-4fcd-47f3-bbab-de5ab5ff972e",
"name": "sample string 2",
"sales_organization_id": "85fa919b-d449-4ddc-9772-f9762fd421e3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00",
"code": "sample string 7"
},
"job_priority_id": "48de19e3-d83e-4fa2-a454-b5da398bf2c9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9db4c58-5ab7-4060-aa4c-51e7e81b35c6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e2dbac71-f934-496b-9060-72aa45618c44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00"
},
"job_status_id": "dfe3d7c8-5ad0-41bc-a60c-2ef45b38c942",
"job_status_code": "sample string 11",
"db_address_id": "84d26329-2553-4bfa-8b77-94b14cbeed66",
"contact_id": "260537ad-09ce-4514-80f3-411a487b4ace",
"requested_by_company_id": "d0c62e9a-7adb-4ed5-803a-897f886f926f",
"requested_by_contact_id": "9b077169-5034-4b54-91af-293ecf84981f",
"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-02-18T02:55:35.6486475+00:00",
"due_date": "2026-02-18T02:55:35.6486475+00:00",
"date_create": "2026-02-18T02:55:35.6486475+00:00",
"date_update": "2026-02-18T02:55:35.6486475+00:00",
"date_closed": "2026-02-18T02:55:35.6486475+00:00",
"suggested_user_id": "e479ad4d-5f91-4369-978e-ce76388cf0f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "46be7343-55a0-4771-8b3d-cae056044156",
"db_language_id": "b0f0eecc-0c8e-49f7-8126-269e3dfbeceb",
"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-02-18T02:55:35.6486475+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1808af03-4ebe-436e-97d8-a10c47f943df",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0bb50842-d0b2-4286-bfd5-cae88c593cab",
"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": "23cdb891-cf10-4376-9c32-1ca7eb4ce0f5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f96be0c9-8021-4386-bdec-80a473ec6fc3"
},
"suggested_date_start": "2026-02-18T02:55:35.6486475+00:00",
"skill_id": "57a0300d-6658-49f3-8741-94622fc9a1f7",
"skill_code": "sample string 32",
"skill": {
"id": "75d6080c-7991-4bd1-9e34-db19f22ed4f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf850988-3064-40d5-9411-7fa0f81071cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "787eec5e-694d-4a63-9475-a3f71233cfc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c853ba72-c614-4144-8831-8758d5a24dc1",
"db_currency_id": "018a883f-455b-4694-9ef3-6340914a973c",
"db_language_id": "566e2b9c-3069-416c-b704-5f540fe0ae74",
"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-02-18T02:55:35.6330222+00:00"
},
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f7fdb9aa-ef49-4015-9639-5954b7254ef0",
"date_reported_by_company": "2026-02-18T02:55:35.6486475+00:00",
"id2": 36,
"company_id": "92de32d9-5b8b-4120-b349-4e1b1d2eb1c8",
"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": "bf020cee-f9c2-4f4c-aea6-094a4fa89aa5",
"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-02-18T02:55:35.6486475+00:00"
},
"work_instruction_details_id": "9a36a8ec-8230-4aa6-845d-094debd45fb1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55cd2b88-582c-467d-98b6-a1f8376598ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ef119f7e-0250-4775-8401-bd661ed54e41",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T02:55:35.6486475+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": "b1441625-6e1d-4aa3-8c8b-f4b88f567dc7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T02:55:35.6486475+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.