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": "5381bfc9-49d3-4bec-8990-742f5e995887",
"jobs_id": "5e2b7d4e-dc6e-4d23-aae7-e78f92a08c69",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "63abe597-e920-407f-be66-e715477027b2",
"_parent_id": "f25b5464-9bec-45d4-b70b-e58b82f3c3f7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac1d0bc8-7a1d-4620-9f86-80b06f7f55f5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3f5038f5-1a18-4671-b11b-e97897d9851c",
"_parent_id": "2a385fd2-0bd0-45b6-94dd-e1dabdcfefa4",
"root_parent_id": "3f948653-56f0-47db-94bc-9742c40bf32a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ed40b720-1655-4d69-957c-c83846eb5f83",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0d495c9c-b976-44f5-8242-5fda2aead6eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77cab644-b279-498b-b05f-2730bc8228e2",
"_parent_code": "sample string 6",
"sales_organization_id": "5df499c3-7fe2-41b1-a62b-44ecb5cade1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"equipment_model_id": "ce6c034b-2922-4df1-82f6-226a07574383",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fd810222-f949-481b-a395-359285be94a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59cdf63f-c83f-4161-9f23-ddbb2fc176ef",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "74f39096-fd49-4fdd-863a-5c8005eea83c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f38655c8-156f-47b7-98d4-7d64983a2408",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"equipment_family_id": "fc671ce2-9fcf-4754-ac0a-db234a8d971d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0d495c9c-b976-44f5-8242-5fda2aead6eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77cab644-b279-498b-b05f-2730bc8228e2",
"_parent_code": "sample string 6",
"sales_organization_id": "5df499c3-7fe2-41b1-a62b-44ecb5cade1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"date_in_production_since": "2025-11-21T15:43:42.3631021+00:00",
"date_out_of_production_since": "2025-11-21T15:43:42.3631021+00:00",
"date_end_support": "2025-11-21T15:43:42.3631021+00:00",
"sales_organization_id": "2ac0dc47-fa8a-454e-ad4d-e9f7940f53c7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+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-11-21T15:43:42.3631021+00:00"
},
"project_status_id": "05b9c748-68db-43d4-ac50-a7bc28c87ca0",
"project_status_code": "sample string 10",
"project_status": {
"id": "e17c2a19-d660-4c73-9b78-15ff37757f43",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "705cf9f5-a0ee-4f14-a9d2-17f98785f2dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"company_id": "e6067210-af1f-42cb-a000-f44dddf7cf26",
"company_code": "sample string 12",
"db_address_id": "b7a993d0-bd2e-43e8-a702-15258ec89b4b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6ba9bb49-3411-45d6-98fe-1badaaccf6a7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4d2f9352-5da9-46c3-9154-8496ffabca98",
"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-11-21T15:43:42.3631021+00:00",
"date_create": "2025-11-21T15:43:42.3631021+00:00",
"date_update": "2025-11-21T15:43:42.3631021+00:00",
"updated_by_user_id": "8b139433-5051-4a7c-b269-288fe55244bf",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-21T15:43:42.3631021+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-21T15:43:42.3631021+00:00",
"date_last_job": "2025-11-21T15:43:42.3631021+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-21T15:43:42.3631021+00:00",
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00",
"is_mobile_installation": true
},
"job_type_id": "0cc02c63-5fd7-4262-a05b-4ca5b8de9c52",
"job_type_code": "sample string 7",
"job_type": {
"id": "4745a56d-8c00-449b-9606-d610b03a9708",
"name": "sample string 2",
"sales_organization_id": "93044805-fa60-4cc5-be66-b55c8b6d8839",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00",
"code": "sample string 7"
},
"job_priority_id": "8c6494ca-f58e-4cfb-882e-ae13d5a21c4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "932d12dd-bb57-4651-8e81-d3f12bb6d9bb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb9d3541-cad6-4e80-b43f-ac695c2d538a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"job_status_id": "077143b9-84e7-400d-a76a-cd6f49023ad6",
"job_status_code": "sample string 11",
"db_address_id": "ed32bb6f-f782-4dad-84de-2c483fe7de4f",
"contact_id": "0704d23d-e959-4e9e-84c3-328d79dc6d22",
"requested_by_company_id": "239a418c-bd72-4280-a11b-5b91b23284bd",
"requested_by_contact_id": "78c8c91e-73c7-4df5-bb6d-59a4abc5b13a",
"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-11-21T15:43:42.3631021+00:00",
"due_date": "2025-11-21T15:43:42.3631021+00:00",
"date_create": "2025-11-21T15:43:42.3631021+00:00",
"date_update": "2025-11-21T15:43:42.3631021+00:00",
"date_closed": "2025-11-21T15:43:42.3631021+00:00",
"suggested_user_id": "2bb473e1-a24c-4e37-a918-6e8eb35de9b7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "181209d8-f912-48eb-934e-dbffc66aa7ac",
"db_language_id": "c55ac5ca-2eb9-4ab7-8e02-2bee49cb7be4",
"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-11-21T15:43:42.3631021+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3861d541-b7cb-4771-8633-cf716733932c",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3afb23e9-61f0-452c-8531-cfb0275af36c",
"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": "e159de9b-15c1-41da-ac3e-937c28c57394",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f33bbbd6-c215-4d2c-a431-740bfbfbf166"
},
"suggested_date_start": "2025-11-21T15:43:42.3631021+00:00",
"skill_id": "dd0b3cc9-c149-4164-944e-690014a10c2b",
"skill_code": "sample string 32",
"skill": {
"id": "8c85c4c9-91fe-4879-86b9-09a80ef50676",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6bba91b7-a1f5-48d6-9be1-e94991b11076",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd84c3f5-e34b-4edd-b3ea-9e0fda1c06f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2119037-f52c-4607-a7db-ff3a27407157",
"db_currency_id": "1dfd5f8f-5971-4bbe-b470-907ee6bd4649",
"db_language_id": "2f68a342-8f4d-4caa-875f-796cd451f47e",
"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-11-21T15:43:42.3631021+00:00"
},
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1cc13a61-fa05-4f1c-84ac-2c95cdb0c1d4",
"date_reported_by_company": "2025-11-21T15:43:42.3631021+00:00",
"id2": 36,
"company_id": "e44dddc6-8c2d-486e-a01a-d825bc028b79",
"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": "ca6bd6ea-b4ba-477d-9222-9b670c5a10d3",
"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-11-21T15:43:42.3631021+00:00"
},
"work_instruction_details_id": "5420d7e3-1611-4d6c-a534-e6c1cd2165ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a7ed126c-31da-4676-97ba-06aa15691be6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2b5644f2-e931-4103-86f5-dc748b32d98f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-21T15:43:42.3631021+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": "e88b60ca-c13f-4d4d-be1e-126cde2a51d4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-21T15:43:42.3631021+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.