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": "408b412d-c90b-4824-9e90-171bd34413b6",
"jobs_id": "29e7ae58-1e8e-4dd9-ad24-c82b6725131f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0eaa7036-3e87-4490-b5f8-e74c7dacde35",
"_parent_id": "69d3d531-2f87-4e0c-97a1-c48c4e78fabf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "95cec4ee-b068-410b-8bdc-ee4239514ca5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d117209e-870b-4d2b-911c-6777b66fd582",
"_parent_id": "4443cf51-bb9d-4c68-ab0e-d67fd7916054",
"root_parent_id": "0e5d7182-3360-4b4c-bd6b-303c4c30618b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "31c795f6-7272-4e45-bdd1-d55251ddb79b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f24f7f6-0333-491e-a7cc-62bc1daff350",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de3d530c-c170-43c7-b698-bef553bac1b5",
"_parent_code": "sample string 6",
"sales_organization_id": "ef1662c0-6e7b-4ab8-b2fc-2e9193fa4618",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00"
},
"equipment_model_id": "a8af738f-7d5e-4b68-928d-46ca893a46cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1c9b89f3-c8fd-406e-9001-2ced40e46b07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "824b75df-a19d-4178-af65-157b6df0dc3b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a2c3d4b8-5b8a-41cf-92e4-6c99e0e5eefe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8810dd75-0a60-4326-b369-5d0b95fb7f3c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00"
},
"equipment_family_id": "5a108425-d1dd-4f0e-96ff-b3e849684996",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f24f7f6-0333-491e-a7cc-62bc1daff350",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de3d530c-c170-43c7-b698-bef553bac1b5",
"_parent_code": "sample string 6",
"sales_organization_id": "ef1662c0-6e7b-4ab8-b2fc-2e9193fa4618",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00"
},
"date_in_production_since": "2025-11-23T11:06:50.4320355+00:00",
"date_out_of_production_since": "2025-11-23T11:06:50.4320355+00:00",
"date_end_support": "2025-11-23T11:06:50.4320355+00:00",
"sales_organization_id": "d8ad1359-c87f-4a7a-b3b7-275eaba72cf8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+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-23T11:06:50.4320355+00:00"
},
"project_status_id": "7a284a2b-0ba3-4ec6-9d6e-df9c7d83c262",
"project_status_code": "sample string 10",
"project_status": {
"id": "0b3ead55-075d-49f4-8e25-3c5af3222147",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2aca6ba6-1a3c-4115-b647-9b21d08522d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00"
},
"company_id": "ae875b4f-fb95-4a7f-baf9-432547010f05",
"company_code": "sample string 12",
"db_address_id": "515a367e-7b5c-432f-95c3-36e0c83047ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00254550-e55c-47aa-bf01-1e6a5d308ea4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6a4ac2d0-f7f2-495f-aac1-552925532174",
"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-23T11:06:50.4320355+00:00",
"date_create": "2025-11-23T11:06:50.4320355+00:00",
"date_update": "2025-11-23T11:06:50.4320355+00:00",
"updated_by_user_id": "b0c0a440-4366-4517-a3c2-7765ffb0edad",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-23T11:06:50.4320355+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-23T11:06:50.4320355+00:00",
"date_last_job": "2025-11-23T11:06:50.4320355+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-23T11:06:50.4320355+00:00",
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00",
"is_mobile_installation": true
},
"job_type_id": "53792e83-9ad2-4c8c-9a00-d7464cc4b79d",
"job_type_code": "sample string 7",
"job_type": {
"id": "891abe1d-ca5c-456f-81af-3be50eda0354",
"name": "sample string 2",
"sales_organization_id": "c9c04aef-633e-4b9c-9038-cd3dd7fc81f9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00",
"code": "sample string 7"
},
"job_priority_id": "fc488975-3442-4ff8-8c34-4bbf5ac4b798",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "67006ff1-e10b-4f81-967b-7b345e530c6e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7836ea4c-c94b-4540-a590-abc2c441a007",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00"
},
"job_status_id": "018ba4a1-f33e-4d69-8e9b-81e20943ebcc",
"job_status_code": "sample string 11",
"db_address_id": "9f590197-fbcc-4031-8ff0-e5ea00b2288f",
"contact_id": "0b48aad6-f9ff-4213-83cd-87d96c070674",
"requested_by_company_id": "fb94d282-c47e-409c-bb7f-cedca3ecd48d",
"requested_by_contact_id": "0afdfa46-7190-4290-9570-e3761489e5bb",
"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-23T11:06:50.4320355+00:00",
"due_date": "2025-11-23T11:06:50.4320355+00:00",
"date_create": "2025-11-23T11:06:50.4320355+00:00",
"date_update": "2025-11-23T11:06:50.4320355+00:00",
"date_closed": "2025-11-23T11:06:50.4320355+00:00",
"suggested_user_id": "77897a87-072f-4f44-b7af-5d8a4898b322",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "41758be6-e82f-465f-b3db-6d99121e7111",
"db_language_id": "af8c9690-9274-42b0-b226-db6c59a51eb8",
"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-23T11:06:50.4320355+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9cbffb6a-8d32-44a5-91b2-2afa64625d35",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ee6a0ce9-53cd-4267-9806-268b948cceec",
"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": "c1647b50-e7d2-4e2a-84ce-a71f59310326",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-23T11:06:50.4320355+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "79feb410-9ec8-4550-a7fe-8447f7f2974b"
},
"suggested_date_start": "2025-11-23T11:06:50.4476619+00:00",
"skill_id": "62ea81fc-bb9f-41d4-9dd6-bce4e0ea998c",
"skill_code": "sample string 32",
"skill": {
"id": "da6b9f90-a230-4080-bce1-941dd6496d64",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9ad83fd6-d396-4809-8cef-022403c04cdc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb391a2-4a50-4747-b9af-5b4085cf4bf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94fd95dc-f347-457b-b292-6d5b295c1504",
"db_currency_id": "bfda076f-a8f0-4ded-99bc-cac4ac79cd4f",
"db_language_id": "ef858604-b2b6-47b3-b94c-84dcafb6d3db",
"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-23T11:06:50.4320355+00:00"
},
"modified_dateutc": "2025-11-23T11:06:50.4476619+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f7b9871-b7fa-402c-bdeb-3d0847a072be",
"date_reported_by_company": "2025-11-23T11:06:50.4476619+00:00",
"id2": 36,
"company_id": "b1964d59-d1cd-44e0-843d-38b0eb9e5956",
"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": "88d4a227-52ed-47d5-ade8-e687fd520f8c",
"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-23T11:06:50.4476619+00:00"
},
"work_instruction_details_id": "1b20814f-d2c2-4338-a034-567ccb5f0d4e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b3c47f75-1326-4368-9c0a-7746b21cf59c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a30eb6e8-ab7b-41ef-8197-f35720a5a9c1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-23T11:06:50.4476619+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": "c0774fee-8671-48e7-9f70-ca708b3be66d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-23T11:06:50.4476619+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.