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": "b4ac6e56-3155-42a0-9c7f-f975bd481aae",
"jobs_id": "3e272f1e-9c14-491c-b3ea-10a0640149ba",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "da8489cb-16d8-433a-a999-907228003cd1",
"_parent_id": "33bb9755-06d1-4a81-b005-bfa49e01bced",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d46f2cd5-4635-4ea0-8148-6ecd29d01e35",
"project_reference_back_office": "sample string 5",
"project": {
"id": "50f1bf31-1da3-4931-bbe0-93f9a2bb30fb",
"_parent_id": "8787eeff-1065-4f0d-a45b-df9dd820dcf7",
"root_parent_id": "270efee1-4f4d-473e-8d4f-c187efbd48db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1c734e39-66f3-4ae8-ae5b-f327e9506cac",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5209b52b-fe40-476f-86ae-214f6290bf9d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b69b47e-44c4-48a0-bbf8-ba12d6021ff8",
"_parent_code": "sample string 6",
"sales_organization_id": "f22cde50-a451-4659-b825-9649c5dbd51d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"equipment_model_id": "e2273202-dd03-466d-a193-cb49fff45ef2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "53e4ca6e-51cf-4483-ab36-04d033ba916d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "28b0130a-47f0-4ff9-a422-a2a1837b4f8f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e2a4de0b-542c-4b5c-bb5d-02397eb520b7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "44a3af7d-add5-4aa7-941d-07ac96cbc81f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"equipment_family_id": "7ca844e1-aa7a-48c4-9549-514b9497d82e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5209b52b-fe40-476f-86ae-214f6290bf9d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b69b47e-44c4-48a0-bbf8-ba12d6021ff8",
"_parent_code": "sample string 6",
"sales_organization_id": "f22cde50-a451-4659-b825-9649c5dbd51d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"date_in_production_since": "2025-04-25T00:39:23.4537571+00:00",
"date_out_of_production_since": "2025-04-25T00:39:23.4537571+00:00",
"date_end_support": "2025-04-25T00:39:23.4537571+00:00",
"sales_organization_id": "0baf7dfd-b2ab-4d8a-80dc-d3f76948f85e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+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": "2025-04-25T00:39:23.4537571+00:00"
},
"project_status_id": "16a059c5-a52b-4893-90f5-3f7849777322",
"project_status_code": "sample string 10",
"project_status": {
"id": "898ee8d8-0e4d-44e9-a2bb-3f6f61afe7e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8578cd9-64d7-459b-b16b-850b986aec29",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"company_id": "a599ab7f-8f31-4c13-915b-7636020d7c97",
"company_code": "sample string 12",
"db_address_id": "ab3e987f-3bac-460b-9118-ddc84ae83365",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ede9eb4f-6b0e-4b0e-8cdf-565b1bf968c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fee6ee24-34f4-4958-8028-4b4ce1cc1a2c",
"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": "2025-04-25T00:39:23.4537571+00:00",
"date_create": "2025-04-25T00:39:23.4537571+00:00",
"date_update": "2025-04-25T00:39:23.4537571+00:00",
"updated_by_user_id": "4fb77212-de93-4132-89a5-83b27da34494",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-04-25T00:39:23.4537571+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": "2025-04-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-04-25T00:39:23.4537571+00:00",
"date_last_job": "2025-04-25T00:39:23.4537571+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-04-25T00:39:23.4537571+00:00",
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00",
"is_mobile_installation": true
},
"job_type_id": "af7d148d-0751-4d2c-8e90-e5620e295980",
"job_type_code": "sample string 7",
"job_type": {
"id": "3561324e-e984-4927-91ee-ff79bed6e6dc",
"name": "sample string 2",
"sales_organization_id": "e1c1a1d5-ddc6-428a-825b-540a9ff91445",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00",
"code": "sample string 7"
},
"job_priority_id": "561ecfb1-e539-4eca-90bb-c1e8606a0f78",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "704b30e1-de5b-4731-885c-7c58ce927cbc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7129b904-f4e0-438c-ab96-270a852bb159",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"job_status_id": "1d9f9b6b-ba8d-4166-a6d1-6483339e154b",
"job_status_code": "sample string 11",
"db_address_id": "eacf2c93-c2cd-45a3-9e2a-b2c057d16c58",
"contact_id": "96cebb17-ec72-4bf5-a445-37a215f981cc",
"requested_by_company_id": "680d84f9-9169-4349-89ad-95b7b5c2ca09",
"requested_by_contact_id": "2e607fe6-1ab7-45df-b76f-4d976aa5de31",
"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": "2025-04-25T00:39:23.4537571+00:00",
"due_date": "2025-04-25T00:39:23.4537571+00:00",
"date_create": "2025-04-25T00:39:23.4537571+00:00",
"date_update": "2025-04-25T00:39:23.4537571+00:00",
"date_closed": "2025-04-25T00:39:23.4537571+00:00",
"suggested_user_id": "45658ab7-ca9e-4543-ba1e-606a74cc8669",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4a43138e-ee1d-44f9-af45-a60d2be25341",
"db_language_id": "649147fa-0b10-4d77-bdb5-557b7bc109b2",
"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": "2025-04-25T00:39:23.4537571+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "07619cc3-9e50-4040-bd6d-c010952092c1",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a967928d-0c58-466e-b3d2-cf19b9a0df98",
"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": "a18a3b20-b1e6-45b4-91a7-5394dfbaf434",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9333ec13-b3ee-4d7c-832a-bc92a8b3e20d"
},
"suggested_date_start": "2025-04-25T00:39:23.4537571+00:00",
"skill_id": "2e4720b6-925a-4f79-a7dd-e678f4b7247a",
"skill_code": "sample string 32",
"skill": {
"id": "a8a86674-af0b-4ff9-9974-598d31ded111",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bdfebbb1-973e-48c1-935a-5012efc15d2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9ddd3f-9d79-4f93-bad7-8f205dc7d390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a858375-ad2c-4121-ac28-29ee33e655cb",
"db_currency_id": "8f5ef5c7-ac69-4153-9373-e631edf5f1c6",
"db_language_id": "76e12e30-aa1a-4a93-a0f7-a39deed89e55",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3996e8fc-326f-4299-b123-2da7777829e5",
"date_reported_by_company": "2025-04-25T00:39:23.4537571+00:00",
"id2": 36,
"company_id": "09dac604-ac4e-4e7c-8a57-510bdc8b9a7d",
"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": "d1eef3e3-caa9-4a8c-8c12-78d6d3db582a",
"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": "2025-04-25T00:39:23.4537571+00:00"
},
"work_instruction_details_id": "dfc0cf57-3a46-406a-b3a9-c761ddc513d2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "58dbfbca-ef77-4602-bb3f-2f755f92b468",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "93c18de5-96f1-4059-9236-1637c56ffd07",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-04-25T00:39:23.4537571+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": "41a76ffd-a878-4266-bea2-d673283074ac",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-04-25T00:39:23.4537571+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.