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": "acc3232f-27d0-4eba-b5ba-4a3c602fa0cb",
"jobs_id": "a7bfe2c6-161a-49cb-8e3c-5e886fd2d344",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e687e2d0-76a0-43f6-a571-5a38ec116fa5",
"_parent_id": "e18e2821-c7f2-4065-9a56-b326f12efffc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2db0c0e8-fcdb-438a-a510-c3775618b1fc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "abee604a-1699-48be-8f10-af52ea2f997f",
"_parent_id": "f1d9f676-886e-4c6d-ada9-2dd90574bf8b",
"root_parent_id": "35993c0d-3ca1-496e-93a4-dd12c73ca5d5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3c428978-fb7e-43e8-bad6-40b5976a7879",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cddbfb60-b8ce-4e3b-a5d5-4503c4a8e251",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59e2fcd2-8d1c-4681-baba-9de8419a3192",
"_parent_code": "sample string 6",
"sales_organization_id": "62f323be-d0fa-49fe-8491-3e9e68c1ef90",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"equipment_model_id": "bf0af720-925e-4768-87c4-fd6cff3b663c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "396e2834-651b-41b8-b52d-a11e2f42a93c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "338c764c-89a4-4957-ad26-0c4780892a0d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "76815104-785e-4aeb-9666-c0b7707b62cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "299e2644-515c-4496-a74d-b46c4cb5c3a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"equipment_family_id": "68cdf14b-7d52-4f08-bb35-a46144efee89",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cddbfb60-b8ce-4e3b-a5d5-4503c4a8e251",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59e2fcd2-8d1c-4681-baba-9de8419a3192",
"_parent_code": "sample string 6",
"sales_organization_id": "62f323be-d0fa-49fe-8491-3e9e68c1ef90",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"date_in_production_since": "2026-02-02T14:37:45.5681349+00:00",
"date_out_of_production_since": "2026-02-02T14:37:45.5681349+00:00",
"date_end_support": "2026-02-02T14:37:45.5681349+00:00",
"sales_organization_id": "2c4b50d7-8ab4-4579-b0c8-3175461b6e8d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+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-02T14:37:45.5681349+00:00"
},
"project_status_id": "2d44d275-6b5b-48d3-abc3-b0d0b3e7805d",
"project_status_code": "sample string 10",
"project_status": {
"id": "281c126b-2cda-43a7-b4ea-59c6997d5a9c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0133f78-8e82-4fa1-bd75-f0db4b8cc892",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"company_id": "a78e494f-4919-4444-9f80-3805e332f34d",
"company_code": "sample string 12",
"db_address_id": "c07549a5-0a72-47ee-bbba-e4508cb1769a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ef40d79-ad0d-4947-a1ed-411a6c75a35d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "79f6bc04-d9d8-4b7c-a0c8-fb97f8cfbb92",
"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-02T14:37:45.5681349+00:00",
"date_create": "2026-02-02T14:37:45.5681349+00:00",
"date_update": "2026-02-02T14:37:45.5681349+00:00",
"updated_by_user_id": "ad6406ed-6f65-45e1-a096-c2a867d9f62c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-02T14:37:45.5681349+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-02T14:37:45.5681349+00:00",
"date_last_job": "2026-02-02T14:37:45.5681349+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-02T14:37:45.5681349+00:00",
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00",
"is_mobile_installation": true
},
"job_type_id": "49cdf635-1ce5-42c7-949f-995e3a2210ff",
"job_type_code": "sample string 7",
"job_type": {
"id": "45c2970e-53a2-47d1-89da-8e0251bb598c",
"name": "sample string 2",
"sales_organization_id": "73c4e8e8-faf4-4552-82aa-ea05de1a6398",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00",
"code": "sample string 7"
},
"job_priority_id": "8f678657-44f9-499b-801c-637df9fd70a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a7472757-af8e-49de-8ff6-f57e7d3db776",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ded1dc5c-7bac-4ee0-bed9-1d651378bcc5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"job_status_id": "1327d37f-f052-41c6-945a-2c99ef4b2cb3",
"job_status_code": "sample string 11",
"db_address_id": "e67f7869-1e4f-45bd-9a56-7281f55bf634",
"contact_id": "b5a345aa-b7e3-4e75-bd1e-cdf28c8b01e0",
"requested_by_company_id": "5f415a60-52c8-4c1e-a576-b6621b183cd4",
"requested_by_contact_id": "1e1ae63e-96f0-48a2-b4f5-043837a51d4f",
"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-02T14:37:45.5681349+00:00",
"due_date": "2026-02-02T14:37:45.5681349+00:00",
"date_create": "2026-02-02T14:37:45.5681349+00:00",
"date_update": "2026-02-02T14:37:45.5681349+00:00",
"date_closed": "2026-02-02T14:37:45.5681349+00:00",
"suggested_user_id": "4c64f4fc-4828-483d-9f13-39dbf4b9de6e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "48ad6a3f-8c27-44ee-ac90-093bedf97da8",
"db_language_id": "3296a703-6973-4d90-a038-0f42ba735099",
"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-02T14:37:45.5681349+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3f7bfb3f-97c7-46d7-8a1c-d45493d311b5",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d1dcc33f-e86e-490f-8dfa-8c564845773c",
"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": "e79bc791-775b-426f-951e-8ec28afc81b6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "11c4822e-26c2-4047-a817-7cb2f6f6f4a3"
},
"suggested_date_start": "2026-02-02T14:37:45.5681349+00:00",
"skill_id": "1bd2b7f7-6f7a-47e8-aec6-820f5a58c624",
"skill_code": "sample string 32",
"skill": {
"id": "fbb52df9-fed8-4c26-a162-239f581a69b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3de6a194-57f0-4aff-9119-523234775150",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aea958c9-1817-4272-b2b0-c618275fa915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a94e2c-1e57-487b-a824-2fde88a90809",
"db_currency_id": "6c5366e8-0280-4ce4-b009-9875fa1b4454",
"db_language_id": "5da9e359-eba3-4f94-bff1-b1064f360a95",
"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-02T14:37:45.5681349+00:00"
},
"modified_dateutc": "2026-02-02T14:37:45.5681349+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ae0f52a5-d129-4273-8714-ad65509af107",
"date_reported_by_company": "2026-02-02T14:37:45.5681349+00:00",
"id2": 36,
"company_id": "1dba8afd-7bfc-4d8a-869c-1b2e6db8e520",
"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": "78e2fde6-b9b5-4deb-894f-7949e267e87a",
"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-02T14:37:45.5681349+00:00"
},
"work_instruction_details_id": "9c11aed7-cc07-40f0-8cb9-52a92ba11b77",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "728d9876-fec3-44dc-828c-247ac1fd344d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "60124e28-7bdd-446b-a1a9-367218c789cb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-02T14:37:45.5837979+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": "3ec534dd-bf2f-4621-a1d4-71c031d9d43d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-02T14:37:45.5837979+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.