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": "7e7b8f61-488d-4e50-ba8a-96ab3368f532",
"jobs_id": "f55eae66-381f-47c8-833f-3a61700b7682",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0efa383a-0f3c-472d-806d-22414de210e7",
"_parent_id": "3189818a-5124-4c5c-80fa-a27704920677",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1b4d9bc9-9a1b-45a9-a0e3-a4dd8be215d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee7f3f76-43f7-4514-8776-27d499cae708",
"_parent_id": "64b27739-8195-491e-a94c-acc8ecec8678",
"root_parent_id": "3a21394b-8f78-4152-802c-dc32031ab00a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1c027bd4-0ae2-4d90-a0cd-0bd681fdabb5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1a7280fa-788e-4100-91c9-9275ec7bacb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "459b750b-7c76-4822-8598-874c7ac919c3",
"_parent_code": "sample string 6",
"sales_organization_id": "ba9a0050-99c4-46c7-904d-da2e52970898",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00"
},
"equipment_model_id": "046d840a-ae41-414f-a424-e13f2d4bda37",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "84e8ff4d-0051-411e-a0d4-746ccbbd46fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5fd2dd90-9753-4fb5-969d-c476bdb75701",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e748bf7c-3323-4651-ae98-29cc1e94dd08",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "63b03b30-0c86-4971-a86c-719d2e61de0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00"
},
"equipment_family_id": "53bff1e3-9bee-4521-af01-778b16c446fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1a7280fa-788e-4100-91c9-9275ec7bacb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "459b750b-7c76-4822-8598-874c7ac919c3",
"_parent_code": "sample string 6",
"sales_organization_id": "ba9a0050-99c4-46c7-904d-da2e52970898",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00"
},
"date_in_production_since": "2025-12-31T10:44:07.6413231+00:00",
"date_out_of_production_since": "2025-12-31T10:44:07.6413231+00:00",
"date_end_support": "2025-12-31T10:44:07.6413231+00:00",
"sales_organization_id": "2b6ba9ce-552b-4a50-bced-1ae334b3d38a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+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-12-31T10:44:07.6413231+00:00"
},
"project_status_id": "f74b68cd-07aa-4226-be35-854e5ce111c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "96f9af1d-9d81-4846-9709-3f5a401947c7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bbfa7849-d09a-49fe-a8bf-825d39d46999",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00"
},
"company_id": "af3509c1-38a2-4023-b90d-50dcabd5efae",
"company_code": "sample string 12",
"db_address_id": "b4034cf9-210e-47b4-933a-6a38181257f3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "47f3a459-1c57-49bb-b336-306f1d4476c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c3f7ee95-87b5-4529-8f14-4ac329f754d8",
"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-12-31T10:44:07.6413231+00:00",
"date_create": "2025-12-31T10:44:07.6413231+00:00",
"date_update": "2025-12-31T10:44:07.6413231+00:00",
"updated_by_user_id": "9e09b70c-dc50-46c1-b2fe-08a5ca9b2890",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-31T10:44:07.6413231+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-12-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-31T10:44:07.6413231+00:00",
"date_last_job": "2025-12-31T10:44:07.6413231+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-31T10:44:07.6413231+00:00",
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00",
"is_mobile_installation": true
},
"job_type_id": "809cf2c6-c865-45c2-826c-a553447629b4",
"job_type_code": "sample string 7",
"job_type": {
"id": "d16392d2-ac29-419a-b67a-f4040c8df2f7",
"name": "sample string 2",
"sales_organization_id": "9c48de74-813f-45f9-9ed6-c1328a7e679e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00",
"code": "sample string 7"
},
"job_priority_id": "90220d25-2edb-458e-b115-7cb729aeaca6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "171e2196-e72a-45ce-8152-631294b8fad9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "226e8f5d-fdb6-4c96-a29a-eb040235f655",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T10:44:07.6413231+00:00"
},
"job_status_id": "2aa1ea30-2a38-4f0c-9666-64f9e8ce4d3f",
"job_status_code": "sample string 11",
"db_address_id": "8f335d42-bf2c-4448-bbd4-99e6cdde1ef8",
"contact_id": "dddc0c9a-bb91-4274-a9bc-563355dd3ba1",
"requested_by_company_id": "6ea64cac-4f6f-48cc-9e42-e6643478af32",
"requested_by_contact_id": "cfdd6211-19cb-4dfa-be91-dedc49053f8a",
"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-12-31T10:44:07.6413231+00:00",
"due_date": "2025-12-31T10:44:07.6413231+00:00",
"date_create": "2025-12-31T10:44:07.6413231+00:00",
"date_update": "2025-12-31T10:44:07.6413231+00:00",
"date_closed": "2025-12-31T10:44:07.6413231+00:00",
"suggested_user_id": "9238d294-8643-4562-a099-ab74c873b92e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "430d6906-1b8b-40fd-b8d2-afed958e8280",
"db_language_id": "6939d7d5-2c43-4034-8b81-6698617803bf",
"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-12-31T10:44:07.6413231+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7e570ca1-27b8-4f9f-b0ac-859b8d7c9310",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4cb0d41b-d0c0-4f18-a3f1-d065a9a94d4d",
"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": "2dccd659-c7a3-44cd-8722-c67eaebfa6a4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-31T10:44:07.6568823+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d4833f6b-6b67-4c11-8c0e-e3cbcfc0afb3"
},
"suggested_date_start": "2025-12-31T10:44:07.6568823+00:00",
"skill_id": "b9eb33a0-969c-4c68-b56b-53290db26a32",
"skill_code": "sample string 32",
"skill": {
"id": "37175370-a3f6-4b61-b2a9-dd674b30fc11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b7dffab3-d9f5-4957-b9da-64e40b61702f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "127c2bfb-7b2a-4a06-ae04-537195f98712",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3968f60c-d1ba-468a-af4f-81b2dc3360da",
"db_currency_id": "2b0563c3-047a-4175-9718-135aa60811a5",
"db_language_id": "69b7e9fe-5716-453c-a758-df13368c1a26",
"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-12-31T10:44:07.6413231+00:00"
},
"modified_dateutc": "2025-12-31T10:44:07.6568823+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6480b526-80c3-4fc1-aea2-92ad061da4e6",
"date_reported_by_company": "2025-12-31T10:44:07.6568823+00:00",
"id2": 36,
"company_id": "ae914619-e2ab-40fd-b34c-ebb910cfb501",
"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": "a668c70e-e060-462e-8d45-c080cf264754",
"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-12-31T10:44:07.6568823+00:00"
},
"work_instruction_details_id": "d1be8ac4-6a39-4ffa-95b0-87c57d2bd7e7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "26d89242-7ca7-47d4-80a7-16541c0e83df",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bd5a5116-b8e3-4318-a7fc-8474261e0f9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-31T10:44:07.6568823+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": "f357b409-1b84-4e91-8e3e-53cc618b050a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-31T10:44:07.6568823+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.