Updates the job work instruction list with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

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: 50

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: 50

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": "cc2b85c1-516b-43f2-9ece-75bcc79d4356",
  "jobs_id": "5e30e381-f292-49b7-bd09-5cb0159130dc",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "7e2035af-377b-456a-bc30-dd6a602d4de5",
    "_parent_id": "2049f093-a955-4ab0-8771-104c484e25f2",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "eb30eff7-8879-46be-bfdd-b59f559da071",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "58a1fd19-038b-4b6e-a77d-145ef66a0938",
      "_parent_id": "40b6f5f4-e120-4bed-9cec-c30e0ed54fa6",
      "root_parent_id": "d07b1f87-483b-435b-91da-497ec6bfcc3b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "9b0956ba-446b-4c1c-8461-94d66cf4a744",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "116597a9-cecb-4d2d-a7de-f8b3bf46e574",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "aa8b6224-9eb2-4428-9e23-b4738ce6d70d",
        "_parent_code": "sample string 6",
        "sales_organization_id": "f7c32825-8112-4c92-afe4-265bdbe5e013",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
          "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
          "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
          "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": "2022-08-17T02:37:59.2645298+02:00"
        },
        "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
      },
      "equipment_model_id": "9bb6655c-150d-405a-9c2c-319a85d64577",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "4a4e27ce-ee0a-4532-b285-47e188a8a2a1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "6b87d9f0-58de-46a8-b6a2-2360603e0c0a",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "8b3b803d-1728-40c3-a721-e42d8568c56b",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "3bce3394-8589-4391-8590-3af1cf82c629",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
            "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
            "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
            "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": "2022-08-17T02:37:59.2645298+02:00"
          },
          "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
        },
        "equipment_family_id": "0ac1b2a8-c4a5-4bd9-b9d2-91fc7750dce5",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "116597a9-cecb-4d2d-a7de-f8b3bf46e574",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "aa8b6224-9eb2-4428-9e23-b4738ce6d70d",
          "_parent_code": "sample string 6",
          "sales_organization_id": "f7c32825-8112-4c92-afe4-265bdbe5e013",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
            "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
            "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
            "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": "2022-08-17T02:37:59.2645298+02:00"
          },
          "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
        },
        "date_in_production_since": "2022-08-17T02:37:59.2645298+02:00",
        "date_out_of_production_since": "2022-08-17T02:37:59.2645298+02:00",
        "date_end_support": "2022-08-17T02:37:59.2645298+02:00",
        "sales_organization_id": "7bf2e8c2-73d9-4f71-946e-74bea746b206",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
          "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
          "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
          "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": "2022-08-17T02:37:59.2645298+02: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": "2022-08-17T02:37:59.2645298+02:00"
      },
      "project_status_id": "b6ecbe17-059e-42ba-980b-fa8ba952e6ea",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "00cc079f-2915-4acb-90f0-7978631f4158",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "38065e54-fc31-435d-91fd-b9b4b49d5eb7",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
          "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
          "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
          "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": "2022-08-17T02:37:59.2645298+02:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
      },
      "company_id": "02f1eaf6-0323-4c9e-9edd-18f6ceacde38",
      "company_code": "sample string 12",
      "db_address_id": "80775a8e-1426-4d53-9036-d9a6c126927c",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "1338e188-57cf-45d9-b907-e374d8656772",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "95d725e2-cbbb-4e97-ac26-3cbccc2c0264",
      "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": "2022-08-17T02:37:59.2645298+02:00",
      "date_create": "2022-08-17T02:37:59.2645298+02:00",
      "date_update": "2022-08-17T02:37:59.2645298+02:00",
      "updated_by_user_id": "cbb070c8-6a1a-49c9-a4ca-dbd320ac8093",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2022-08-17T02:37:59.2645298+02: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": "2022-08-17T00:00:00+02:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2022-08-17T02:37:59.2645298+02:00",
      "date_last_job": "2022-08-17T02:37:59.2645298+02:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2022-08-17T02:37:59.2645298+02:00",
      "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00",
      "is_mobile_installation": true
    },
    "job_type_id": "7649c3de-46bc-4acf-8c48-7b38a74bcf89",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "43d48591-4895-4498-bdc6-b7bddf0c0444",
      "name": "sample string 2",
      "sales_organization_id": "82997e77-b931-4d16-95d9-e9d35d32138e",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00",
      "code": "sample string 7"
    },
    "job_priority_id": "b1980df8-75fd-4164-afe7-86ae62c41ad5",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c75920e5-4aa8-471e-9e57-766b3cedc827",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "99d2032d-87d7-47ef-b4b4-d59a8b05a17d",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
        "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
        "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
        "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": "2022-08-17T02:37:59.2645298+02:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
    },
    "job_status_id": "d0bfe471-3968-4bee-831e-a0eb7eddfe42",
    "job_status_code": "sample string 11",
    "db_address_id": "0f7099b8-a18e-41f2-900f-3d3eff4ab7e4",
    "contact_id": "ea530722-84a5-4645-9a0a-60c167b3208e",
    "requested_by_company_id": "cd56bfd0-3c8c-42a2-af11-18fabf43609a",
    "requested_by_contact_id": "cd9ed36b-87d6-4a69-9445-55ab1b0bb137",
    "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": "2022-08-17T02:37:59.2645298+02:00",
    "due_date": "2022-08-17T02:37:59.2645298+02:00",
    "date_create": "2022-08-17T02:37:59.2645298+02:00",
    "date_update": "2022-08-17T02:37:59.2645298+02:00",
    "date_closed": "2022-08-17T02:37:59.2645298+02:00",
    "suggested_user_id": "e66259e2-2ff1-4999-b391-be811b855648",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "e9f15033-e1bc-40be-971a-9e67f74ce43a",
      "db_language_id": "46171245-85b7-4325-9307-7f007a5928e0",
      "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": "2022-08-17T02:37:59.2645298+02:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "79b4bba9-596a-4212-ae39-068dfb975980",
      "sales_organization": {
        "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
        "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
        "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
        "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": "2022-08-17T02:37:59.2645298+02:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "63adbbdb-24b9-47f0-b62b-988223dc3685",
      "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": "9b86d33f-81a9-40bf-8629-b5fcd6a6b1b6",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "772f9744-de55-4588-b11d-0b2c9adeda24"
    },
    "suggested_date_start": "2022-08-17T02:37:59.2645298+02:00",
    "skill_id": "5f97345d-ca29-4cde-9cba-8d9ae1296313",
    "skill_code": "sample string 32",
    "skill": {
      "id": "f5de9c66-1f54-4780-86bf-856fced7f47e",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "9f548999-124d-4d92-9f56-6dd8c57c25d7",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "27a6ad45-973d-4be9-9e41-cb8ce89eeec0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "13b09ac7-f596-4d9d-8150-b78aef313673",
        "db_currency_id": "48982564-6e33-48a4-b6ff-23423fe7efd6",
        "db_language_id": "4d8d55c3-f6f7-464a-af65-7e6a0d0f044d",
        "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": "2022-08-17T02:37:59.2645298+02:00"
      },
      "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "f18d3f38-71dd-4001-b6f5-3f0899895e51",
    "date_reported_by_company": "2022-08-17T02:37:59.2645298+02:00",
    "id2": 36,
    "company_id": "efe6b012-bdb4-41ed-89c2-2b1debe024da",
    "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": "f9e8f545-df37-498e-8c5c-90ae53cd03a6",
    "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": "2022-08-17T02:37:59.2645298+02:00"
  },
  "work_instruction_details_id": "775e9c1f-b8d2-4cdc-ad64-8b23dd7fe070",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "24b56b00-4b5d-4986-bee0-3e09add317d3",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "ce70370e-badf-4d22-95c8-f17b7f0ba0a3",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2022-08-17T02:37:59.2645298+02: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": "b8ee41e6-359b-4e49-9b05-33329fdf026a",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2022-08-17T02:37:59.2645298+02:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.