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": "f973d3d8-7545-4b72-a83e-04100abc0db7",
"jobs_id": "6801b3a1-e4fd-4245-8914-a89713d4c488",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cf0c4a16-e201-432d-9777-ab38bc564af0",
"_parent_id": "deb02446-e3c8-49a2-b830-918482cae78c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "96a15346-ec60-4ed5-ac08-90ac903ea54c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "53419682-2ed5-4061-b799-342c17709ac1",
"_parent_id": "9f5b3e9b-5b61-4f2c-95d3-291076ec73ee",
"root_parent_id": "6c42649e-1de3-4c5f-800f-bac7f011f598",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "579abcb9-92fd-4597-9098-9bc496d8c49b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b45d4df8-9e67-483e-a603-e7cf174d0d0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0b5bb58-dcde-4605-8e93-ea80ac93abd3",
"_parent_code": "sample string 6",
"sales_organization_id": "997793f2-d40e-43f3-9a0a-1f5708350c19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"equipment_model_id": "b8d82f7f-da8e-4f64-96f6-ab9c6eadbe71",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "30d9c06e-d402-403b-be7f-0c4d0f016fea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "78eb8e9c-4186-4779-adcb-69703e5c33a4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "13b9c93d-0769-4a0b-9025-8dae58c8c054",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a81b2f94-7160-41a2-bdbd-3c711de971cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"equipment_family_id": "c5a93200-17e5-4b8f-94bb-0b35032ff9ab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b45d4df8-9e67-483e-a603-e7cf174d0d0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0b5bb58-dcde-4605-8e93-ea80ac93abd3",
"_parent_code": "sample string 6",
"sales_organization_id": "997793f2-d40e-43f3-9a0a-1f5708350c19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"date_in_production_since": "2025-06-03T08:31:36.0106263+00:00",
"date_out_of_production_since": "2025-06-03T08:31:36.0106263+00:00",
"date_end_support": "2025-06-03T08:31:36.0106263+00:00",
"sales_organization_id": "e8566364-6942-4915-aee0-6f52f49906c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+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-06-03T08:31:36.0106263+00:00"
},
"project_status_id": "4bca7c20-0b66-4bfe-82d8-fba4ef19f030",
"project_status_code": "sample string 10",
"project_status": {
"id": "d878e0d9-61ae-4cb5-b55f-a9036037927e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b02de7a5-3382-4b5f-ab2b-68bfcd39a557",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"company_id": "4e6fc3a6-bbe0-4322-84cc-7995523ebc11",
"company_code": "sample string 12",
"db_address_id": "5698c34a-2fd0-4ddb-baa2-91cc8b21269b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c27e89c5-f02b-4afc-b8dc-c0f3b582e39f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "066b9d89-0d04-4b23-b086-7680fc1600bc",
"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-06-03T08:31:36.0106263+00:00",
"date_create": "2025-06-03T08:31:36.0106263+00:00",
"date_update": "2025-06-03T08:31:36.0106263+00:00",
"updated_by_user_id": "bd425b61-0463-483a-92e8-dc3356d5da4c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-03T08:31:36.0106263+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-06-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-03T08:31:36.0106263+00:00",
"date_last_job": "2025-06-03T08:31:36.0106263+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-03T08:31:36.0106263+00:00",
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00",
"is_mobile_installation": true
},
"job_type_id": "548c5e9f-45c5-43f7-a5f9-4707e6112696",
"job_type_code": "sample string 7",
"job_type": {
"id": "37945109-5af3-4047-8b5c-7fbdec931270",
"name": "sample string 2",
"sales_organization_id": "a40a61a1-7222-414b-959a-17a888cce93f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00",
"code": "sample string 7"
},
"job_priority_id": "9f656673-fc3a-4475-807a-76ef6bd07440",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e4eaa627-7de4-4fa4-a3d5-1116c07f8d9e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "70e7d526-1110-42af-9484-126196858410",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"job_status_id": "ba849370-b525-49f8-a3d3-a357e7e67f78",
"job_status_code": "sample string 11",
"db_address_id": "9f7096f5-7386-4916-8049-5c5062fb371d",
"contact_id": "11964198-07ba-4d00-a32b-fff23693f711",
"requested_by_company_id": "5e90c5ea-17a4-4485-a831-1e1d57d70bd2",
"requested_by_contact_id": "5480bb02-b96c-4e0b-980a-96d82f138de1",
"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-06-03T08:31:36.0106263+00:00",
"due_date": "2025-06-03T08:31:36.0106263+00:00",
"date_create": "2025-06-03T08:31:36.0106263+00:00",
"date_update": "2025-06-03T08:31:36.0106263+00:00",
"date_closed": "2025-06-03T08:31:36.0106263+00:00",
"suggested_user_id": "5e00977f-bc13-440a-bc2c-fe052705c4e9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e6b0675d-a11c-4a1c-a56a-488abcfe1dba",
"db_language_id": "ad282d2a-59fb-4629-b808-2ada2f068fc0",
"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-06-03T08:31:36.0106263+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62c5b765-9ff8-4176-9554-0c49544d3094",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aeca140c-3dd3-430a-a54d-62191c5613f8",
"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": "93579d08-7a28-48b6-a63a-97cca09f5660",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8dcd98bd-5436-4ddd-a26b-eb83a6dc8a5f"
},
"suggested_date_start": "2025-06-03T08:31:36.0106263+00:00",
"skill_id": "c4b9626c-63f2-430a-8007-f3c630dc8caa",
"skill_code": "sample string 32",
"skill": {
"id": "36d4fc0f-8df3-40c8-98a8-fa8eb4673658",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5410d5c6-780e-4d5a-8db2-3deebae03abb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20d146bd-0b24-4be5-bd33-a027f94e876c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e93141e-5b39-4340-ad75-3dffb599caf5",
"db_currency_id": "f0562d51-1327-4524-8a10-511a4ff19adb",
"db_language_id": "d86f34ee-80e6-4571-b4bb-23302008f8fe",
"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-06-03T08:31:35.9950009+00:00"
},
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aad10350-269f-4413-8f0d-76fbc259a1a8",
"date_reported_by_company": "2025-06-03T08:31:36.0106263+00:00",
"id2": 36,
"company_id": "7b39399d-9bc1-4e31-96eb-559ffd2f7998",
"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": "9dc98a2a-a3ee-48c4-810d-26a92c9a97be",
"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-06-03T08:31:36.0106263+00:00"
},
"work_instruction_details_id": "02234891-5871-4caf-9c53-ed051d249cb1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e57211f-335d-4f12-a872-92b2d3a2973a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b9d29371-785b-45ed-a302-01772bb777c1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-03T08:31:36.0106263+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": "a73ac93f-15e3-4873-8e3d-7954a5871c55",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-03T08:31:36.0106263+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.