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": "42b220d6-7fd2-470b-a6ca-bef65eb025f3",
"jobs_id": "0f167722-62ef-4f83-93ef-9c3a91087ce0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1cfea3f5-b0a4-411a-9ec4-72c6b0087141",
"_parent_id": "e5a9d58b-c9fe-4ddf-a056-4b537efaabcd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b870a265-a1f8-4256-b6d6-631c439a5e5e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "33708182-6947-4a4b-a240-ff73cf534fec",
"_parent_id": "ddda5726-1166-46a7-a359-fac9ed24d3ea",
"root_parent_id": "6e4b37cd-3928-4358-af42-5550aead10f0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ddfc1741-ab1f-45bf-952e-64184d8b0f5a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9d221400-69f4-4def-a3c3-c15000307124",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6c1b3cc-c1fa-450b-afa7-62eaf5c8a55f",
"_parent_code": "sample string 6",
"sales_organization_id": "3d9a8a76-d96c-473d-9e1e-d0d2a18bee2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"modified_dateutc": "2026-11-04T21:46:57.7540474+00:00"
},
"equipment_model_id": "b0c077cb-8dba-4a64-a749-2bdc0b3eb0fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c54d452a-5733-4019-ab88-87f668aa412b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6be031e8-edcf-4fc8-bf1d-21d20c210c2a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24991ad5-7a44-44b9-a646-3c762b769370",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a28e8c87-03be-45ee-8c8d-eb452b03251e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"modified_dateutc": "2026-11-04T21:46:57.7540474+00:00"
},
"equipment_family_id": "3018898f-8d8e-4a52-ac05-0d327a8ce271",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9d221400-69f4-4def-a3c3-c15000307124",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6c1b3cc-c1fa-450b-afa7-62eaf5c8a55f",
"_parent_code": "sample string 6",
"sales_organization_id": "3d9a8a76-d96c-473d-9e1e-d0d2a18bee2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"modified_dateutc": "2026-11-04T21:46:57.7540474+00:00"
},
"date_in_production_since": "2026-11-04T21:46:57.7540474+00:00",
"date_out_of_production_since": "2026-11-04T21:46:57.7540474+00:00",
"date_end_support": "2026-11-04T21:46:57.7540474+00:00",
"sales_organization_id": "0e95c9be-c06c-469a-ad5e-7ed092df51d6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+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-11-04T21:46:57.7540474+00:00"
},
"project_status_id": "7448d90d-d5b4-4c89-b60a-a810afbaa2f7",
"project_status_code": "sample string 10",
"project_status": {
"id": "38b40614-3d2b-4036-8c1b-165cc8a80eeb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "83e097f3-e9f7-4b57-8362-22e89d708b3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T21:46:57.7540474+00:00"
},
"company_id": "d133847f-be82-422e-b92b-29a9e60df058",
"company_code": "sample string 12",
"db_address_id": "08b915fc-be94-4dc1-9d7b-11a9fb0f1cc7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e5f7d598-d7f6-4db4-9379-42d843bec24b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "67f25844-dcab-4d25-98c0-5a024cfc7178",
"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-11-04T21:46:57.7540474+00:00",
"date_create": "2026-11-04T21:46:57.7540474+00:00",
"date_update": "2026-11-04T21:46:57.7540474+00:00",
"updated_by_user_id": "e4332e79-ff5e-4205-82f6-4cee28b0f007",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-04T21:46:57.7665642+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-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-04T21:46:57.7665642+00:00",
"date_last_job": "2026-11-04T21:46:57.7665642+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-04T21:46:57.7665642+00:00",
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00",
"is_mobile_installation": true
},
"job_type_id": "837bd338-3969-427f-8dfa-3e424540b593",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf3cf374-dffc-4617-b9d1-21718f4a0610",
"name": "sample string 2",
"sales_organization_id": "1ae48673-f5c7-4ed5-9faa-1741076f8b34",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00",
"code": "sample string 7"
},
"job_priority_id": "23b2942a-de34-4da8-aca3-01d5ba4e99cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "233c825a-a398-469b-8302-27c41f42029d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "abdb01b2-9ba5-4ada-ba8c-1703c29b5f34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00"
},
"job_status_id": "35ff4d7d-a4ea-4c05-92bb-6e0a846d985d",
"job_status_code": "sample string 11",
"db_address_id": "428312f7-d41c-4b31-89af-c38ec53fb884",
"contact_id": "44108858-4a31-40c7-b3e0-ba4a3f3b964b",
"requested_by_company_id": "3a768a81-b3fd-44b1-b529-072bfbd78b0e",
"requested_by_contact_id": "9d8b9236-e14e-4f1f-bdbd-eab897158233",
"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-11-04T21:46:57.7665642+00:00",
"due_date": "2026-11-04T21:46:57.7665642+00:00",
"date_create": "2026-11-04T21:46:57.7665642+00:00",
"date_update": "2026-11-04T21:46:57.7665642+00:00",
"date_closed": "2026-11-04T21:46:57.7665642+00:00",
"suggested_user_id": "03435a38-f407-4955-affe-70eb28dfb79d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e0438d76-79e6-451e-8af2-6cff4a903781",
"db_language_id": "4de8a141-7757-4f8e-b669-7f0eea802a0b",
"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-11-04T21:46:57.7665642+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ddfc8e30-b3b2-4974-9d8f-dce3a3faa395",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3d495d26-d857-4a4a-8835-5ebe2a38d483",
"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": "3faa4d4c-f4f0-423a-ac84-26444c5fbd2d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13f29973-7f60-4a2a-b293-35ef4e5205c9"
},
"suggested_date_start": "2026-11-04T21:46:57.7665642+00:00",
"skill_id": "81ae0e50-fa77-4ea3-ba2d-f7a09da4480d",
"skill_code": "sample string 32",
"skill": {
"id": "cdf49cae-b9a6-417b-bc85-ff1dcdcf9d2b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a5203485-f504-4cc7-b4cf-0830c59c227d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3121717f-64e7-41ed-8440-5f6df0933d10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c4d872-ae57-40a1-be99-181baf39fd86",
"db_currency_id": "c88b0ad3-6213-48e0-a063-260264f3aae1",
"db_language_id": "478d52e5-0cb8-43a3-ad35-e844f38fc616",
"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-11-04T21:46:57.7540474+00:00"
},
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dc623754-d517-4ce9-9ba9-defb7e36ad04",
"date_reported_by_company": "2026-11-04T21:46:57.7665642+00:00",
"id2": 36,
"company_id": "3d66fd9d-62ad-4e99-9781-42ab39874aff",
"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": "dca2307a-9757-44c4-b736-e405a9e1459a",
"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-11-04T21:46:57.7665642+00:00"
},
"work_instruction_details_id": "ccefd22b-10a9-48f0-8981-768b4b395fcb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e545d48c-4704-4583-8874-c605cb0ebf55",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "882f4070-7df3-425e-aa09-40bda70acb46",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-04T21:46:57.7665642+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": "49d7bd9f-192e-4152-bbd8-cd0ed5471701",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-04T21:46:57.7665642+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.