Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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": "cadb1718-a304-4645-b396-4fb81049ea31",
  "jobs_id": "4cad942b-7640-44ee-9325-7fbec2ce90d6",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "eecee143-b07c-40fb-893b-92297380426a",
    "_parent_id": "6ce1bb69-3a5f-4128-979d-d735423b1678",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "04078108-24fa-4111-b699-fc30f506a86f",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "0cff1928-e8fb-479e-b59d-68dfaacd587d",
      "_parent_id": "ae46873e-9163-4ba9-b263-ec902f73f141",
      "root_parent_id": "ae2db3bc-99c8-4266-b2a5-bd531cec85d7",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "009f5f07-6df7-4dd7-9f73-a673b28e849d",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "a43cdbba-15fd-4966-bca6-c96311211611",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "dd0fde6f-1c36-496d-a218-1644b33796a3",
        "_parent_code": "sample string 6",
        "sales_organization_id": "68c8f7ad-78ab-4666-b0e3-8786baf02b54",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
          "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
          "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
          "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-12-19T05:41:31.0053257+00:00"
        },
        "modified_dateutc": "2025-12-19T05:41:31.0053257+00:00"
      },
      "equipment_model_id": "115694af-99b4-445f-b440-7e690ae0ea62",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f3e46afb-bcdc-4703-bdf0-a082c59b2a4a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "7aa7fbf5-30b6-4587-a573-e16deb3a6370",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "7e75c8e5-dcfa-40e1-8006-791e9203a0ef",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "491ef3c3-09d3-46a8-ae7b-22f05b693a44",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
            "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
            "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
            "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-12-19T05:41:31.0053257+00:00"
          },
          "modified_dateutc": "2025-12-19T05:41:31.0053257+00:00"
        },
        "equipment_family_id": "3d41e72c-fd20-4ae1-a3dd-f6e4b834b61f",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "a43cdbba-15fd-4966-bca6-c96311211611",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "dd0fde6f-1c36-496d-a218-1644b33796a3",
          "_parent_code": "sample string 6",
          "sales_organization_id": "68c8f7ad-78ab-4666-b0e3-8786baf02b54",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
            "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
            "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
            "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-12-19T05:41:31.0053257+00:00"
          },
          "modified_dateutc": "2025-12-19T05:41:31.0053257+00:00"
        },
        "date_in_production_since": "2025-12-19T05:41:31.0053257+00:00",
        "date_out_of_production_since": "2025-12-19T05:41:31.0053257+00:00",
        "date_end_support": "2025-12-19T05:41:31.0053257+00:00",
        "sales_organization_id": "61fbe52e-2e02-4268-8310-660f789fe1f5",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
          "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
          "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
          "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-12-19T05:41:31.0053257+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-12-19T05:41:31.0209523+00:00"
      },
      "project_status_id": "dfc15386-9189-4586-8184-a5d68cf81549",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "b11dcb66-0a50-45b0-9c5c-a2f34fbf6933",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "39ea54a1-eeba-4d3b-b36f-a668d8f336ce",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
          "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
          "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
          "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-12-19T05:41:31.0053257+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00"
      },
      "company_id": "1f509f79-7111-48dc-b5d8-064d4f4b6647",
      "company_code": "sample string 12",
      "db_address_id": "df9394cd-787e-4f73-8e49-79a4579751a2",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "81704c1f-98fa-44e4-94bb-02180b7af511",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "04692bdb-5393-4390-b03d-d31e21dfbd71",
      "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-12-19T05:41:31.0209523+00:00",
      "date_create": "2025-12-19T05:41:31.0209523+00:00",
      "date_update": "2025-12-19T05:41:31.0209523+00:00",
      "updated_by_user_id": "6dc25166-fc9e-4b85-ab8e-03517a23eb8c",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-12-19T05:41:31.0209523+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-12-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-12-19T05:41:31.0209523+00:00",
      "date_last_job": "2025-12-19T05:41:31.0209523+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-12-19T05:41:31.0209523+00:00",
      "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5f9615f8-5a9b-46d2-8097-35a7b30f60d9",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "31f9a1d4-e514-4609-b368-04a1f2f7b989",
      "name": "sample string 2",
      "sales_organization_id": "6ffde137-3799-4a42-99a3-0eef97770c35",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c9900de8-2d03-42e3-afb9-8bd0bd5f2ab8",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d288fcce-f667-47f9-94bc-054edc5a1dbd",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "83ad4f5c-fe63-43ab-be46-ae4c0d4e2db7",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
        "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
        "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
        "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-12-19T05:41:31.0053257+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00"
    },
    "job_status_id": "04cbc52a-45c1-4328-958f-1cb02cdaca91",
    "job_status_code": "sample string 11",
    "db_address_id": "e846d410-53b7-43ef-854b-9d1b33507375",
    "contact_id": "f7ef83c6-b7fa-4d37-b804-5c4b6b9cf86c",
    "requested_by_company_id": "9478f1dc-09a1-4345-8e5c-40256fdf9dec",
    "requested_by_contact_id": "7af37454-d7ef-42b5-9866-c0972c7ec45d",
    "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-12-19T05:41:31.0209523+00:00",
    "due_date": "2025-12-19T05:41:31.0209523+00:00",
    "date_create": "2025-12-19T05:41:31.0209523+00:00",
    "date_update": "2025-12-19T05:41:31.0209523+00:00",
    "date_closed": "2025-12-19T05:41:31.0209523+00:00",
    "suggested_user_id": "dc56aab6-8cf9-42e9-ae58-afdfbc7f4051",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "aca3cee8-1e7a-4e82-b1d9-b0be54f0bfcb",
      "db_language_id": "a1fbc165-4ce8-4a5f-9d81-c5559459c752",
      "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-12-19T05:41:31.0209523+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "19e9ebcf-e4e1-4561-911a-a70b02e9c3a8",
      "sales_organization": {
        "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
        "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
        "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
        "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-12-19T05:41:31.0053257+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "2ad5cd59-dc82-4cb6-94b1-61de73707e65",
      "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": "a3b87290-4868-4be4-839f-9f9db14a52a7",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "6c03e906-5820-4de9-af61-ba68127b1b3b"
    },
    "suggested_date_start": "2025-12-19T05:41:31.0209523+00:00",
    "skill_id": "d59b1dff-83c6-47af-9d58-64a6f56d9216",
    "skill_code": "sample string 32",
    "skill": {
      "id": "a1eb261c-53ea-4ad8-ba5b-269114da8a78",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "78cf8000-719d-4a77-9d4f-4217c39daf21",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "a6065e94-f8c0-4db8-b408-e15311eeeb2a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "b23ab312-1b24-4cdd-a02f-6293f92cc7f7",
        "db_currency_id": "917676eb-db2e-4e84-ba87-15ee1ed97276",
        "db_language_id": "92706e08-f1a6-43ea-b431-0db094064d25",
        "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-12-19T05:41:31.0053257+00:00"
      },
      "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "33f3a0ec-fb3f-4609-861e-e102c63b4472",
    "date_reported_by_company": "2025-12-19T05:41:31.0209523+00:00",
    "id2": 36,
    "company_id": "29c4b8a9-6489-4b7d-9c6f-413247bb8c62",
    "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": "3f63a308-ef6d-4656-af4f-7f6c50b84e54",
    "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-12-19T05:41:31.0209523+00:00"
  },
  "work_instruction_details_id": "90869c01-8fff-40a9-80b3-d34c49813211",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "e0a4451f-4235-4faf-b363-b755e579254e",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "b6252568-8f74-4dfc-a03b-b9a442014da7",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-12-19T05:41:31.0209523+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": "dcfc2eba-820e-4ee5-95de-1ba7389665e2",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-12-19T05:41:31.0209523+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.