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": "b5fa09b5-4065-4c07-b9fc-ed368a34aa6a",
"jobs_id": "5e4dfeec-8048-49e2-a403-846718aaf9f7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1f4faa57-c17a-4579-a2e4-6c6f2d41f903",
"_parent_id": "92f91ea1-6975-419f-9b32-e9866b9fd9a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a52c7ea5-ddc7-409f-a4cf-7355dab90ab2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d45d6574-6a8d-48ce-a240-c35d7e781c03",
"_parent_id": "8b244921-d07d-4d94-a237-5022cd200f9d",
"root_parent_id": "78f31471-c62b-4410-bbd4-ba3f357e5046",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e61e3db0-7991-416c-a250-6c0f2ab25380",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "54fcd91b-8d83-44e1-b9ba-3ba5a7e27de8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a16dde29-3ee9-4c68-8a37-4247470e337c",
"_parent_code": "sample string 6",
"sales_organization_id": "e94f5116-bf09-42a2-be4d-6acc1363f888",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00"
},
"equipment_model_id": "1ce8c3e3-9dd7-4ede-b1ae-4633bd825e92",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "46baa4c4-c5a9-4c31-99dc-ed821747db1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c5e5e492-3d95-41a9-ba2a-1d680380efa3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5f296bb0-2f3e-485d-bff3-0c3013643134",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "17c6293b-4a99-474e-a51b-1018b564625b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00"
},
"equipment_family_id": "d11b84df-81ec-4ad7-9a8c-951b11e73b8b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "54fcd91b-8d83-44e1-b9ba-3ba5a7e27de8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a16dde29-3ee9-4c68-8a37-4247470e337c",
"_parent_code": "sample string 6",
"sales_organization_id": "e94f5116-bf09-42a2-be4d-6acc1363f888",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00"
},
"date_in_production_since": "2026-09-10T18:23:43.4232357+00:00",
"date_out_of_production_since": "2026-09-10T18:23:43.4232357+00:00",
"date_end_support": "2026-09-10T18:23:43.4232357+00:00",
"sales_organization_id": "6f4e29d6-b2b8-4b62-b714-67f1d7bfe19d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+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-09-10T18:23:43.4232357+00:00"
},
"project_status_id": "4654e85f-5f18-44a5-b264-5282409be535",
"project_status_code": "sample string 10",
"project_status": {
"id": "173f313b-b4a6-4431-9a00-bb7c9dba7958",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e51a2f2e-7ef8-4123-b265-9b1ca2596f44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00"
},
"company_id": "11143f6d-6f0c-47b6-9515-9c7ca942482c",
"company_code": "sample string 12",
"db_address_id": "333ba685-72e0-45ea-a55f-93fa4b6e48bc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd239e18-5c39-4c53-b1c1-c6a9fdcf531e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb9f7ffb-678a-4186-971e-df680caf662c",
"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-09-10T18:23:43.4232357+00:00",
"date_create": "2026-09-10T18:23:43.4232357+00:00",
"date_update": "2026-09-10T18:23:43.4232357+00:00",
"updated_by_user_id": "fe3dea3d-f581-460d-97ef-0cedb6a15e2a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T18:23:43.4232357+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T18:23:43.4232357+00:00",
"date_last_job": "2026-09-10T18:23:43.4232357+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T18:23:43.4232357+00:00",
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00",
"is_mobile_installation": true
},
"job_type_id": "e1204e0d-8959-4f36-aec5-d256770aa849",
"job_type_code": "sample string 7",
"job_type": {
"id": "c20b4fb2-cb02-44e7-8337-eb7f38142164",
"name": "sample string 2",
"sales_organization_id": "afa26839-1018-4743-9de1-dea49a1cd4a9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00",
"code": "sample string 7"
},
"job_priority_id": "dd52fa81-021d-4e20-9618-92f9ccbc45da",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bada7189-b539-409c-b921-c8c45c040de2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb19f2cf-4b6a-494c-a2e8-a9f7e7b23842",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T18:23:43.4232357+00:00"
},
"job_status_id": "bd497d42-4bcd-41d4-8f6e-2ee9e136232b",
"job_status_code": "sample string 11",
"db_address_id": "6e3cb739-bf1d-4aa7-82ef-b8d6480057ee",
"contact_id": "6ec8b7fc-d9ce-4011-bd8b-4c060163458a",
"requested_by_company_id": "5f0059e3-2808-49c6-b59e-cc5f1fa6ff4e",
"requested_by_contact_id": "b69d368c-510b-4cf4-8f5b-448f35922e38",
"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-09-10T18:23:43.438859+00:00",
"due_date": "2026-09-10T18:23:43.438859+00:00",
"date_create": "2026-09-10T18:23:43.438859+00:00",
"date_update": "2026-09-10T18:23:43.438859+00:00",
"date_closed": "2026-09-10T18:23:43.438859+00:00",
"suggested_user_id": "07135708-2e68-4138-bd06-4d47e4ec3f0c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bee7be35-88b9-406b-ac22-b8cb9708e599",
"db_language_id": "7071a81e-178c-4b3d-8cff-ad8ea3ff8390",
"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-09-10T18:23:43.438859+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b4576a66-8277-4f02-af86-bf129367827c",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "089cc30c-007d-4083-8afa-301986b72e68",
"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": "ca9d394f-ebe1-437f-9ff9-bb56b03b1e88",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T18:23:43.438859+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eaed70e0-d236-47fb-8006-3a733188a69b"
},
"suggested_date_start": "2026-09-10T18:23:43.438859+00:00",
"skill_id": "738c2309-a1a1-445b-afca-721099227fc7",
"skill_code": "sample string 32",
"skill": {
"id": "cfae2816-68f6-4808-978f-26eb6ea7ab14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7f2c18f3-a503-4d87-aa6c-707041b81abf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04a51b4-2870-46e3-99c6-e16bf30163fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fde25e-3f7f-40c0-a8e3-eac46c790119",
"db_currency_id": "39745ad8-8972-4033-ba78-98225e16d3d8",
"db_language_id": "e6e63665-b4b3-40f6-9036-d04e78da8f1a",
"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-09-10T18:23:43.4232357+00:00"
},
"modified_dateutc": "2026-09-10T18:23:43.438859+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "262273b0-f6fd-404b-8400-7ff7e756767e",
"date_reported_by_company": "2026-09-10T18:23:43.438859+00:00",
"id2": 36,
"company_id": "fd776e6c-fcaf-4a4d-a920-aeb3ce9e9357",
"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": "17624e5c-f34b-4fcb-947e-f957774610fe",
"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-09-10T18:23:43.438859+00:00"
},
"work_instruction_details_id": "e95dedb9-2a43-4811-a882-264ea5676066",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "479ec44c-043b-46b5-baaf-efce6bd99457",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9a472b7b-b9fa-4eee-a2cb-380536f43877",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T18:23:43.438859+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": "41c0297a-f2e7-468a-9efe-6e7aa4ded113",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T18:23:43.438859+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.