Contents x
    /Endpoint/rest/api/v1/Application/{Id}
    • 18 Dec 2024
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Contents

    /Endpoint/rest/api/v1/Application/{Id}

    • Updated on 18 Dec 2024
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /Endpoint/rest/api/v1/Application/{Id}

    Use the ApplicationData object resource to update Application using Id, Name, ExternalId, ApplicationKey field(s) value.

    Provide the updated record information in your request data and use the PUT method of the resource with a specific record ID to update that record.

    The input parameter must be used in the ApplicationData record structure inside the FieldType parameter in the foreign key fields.

    Foreign key fields are: ApplicationId, AuthenticationId, ModifiedBy, CreatedBy

    Update a record of Application

    • If the Id field value is not matched, then a 404 error is reported (Errors/Not Found), and the error record is returned.. You cannot change Id field value (primary key).
    • If the Id field value is matched multiple times, then a 400 error is reported (Errors/Multible Rows), and the error record is returned.
    • If the Id, Name, ExternalId, ApplicationKey field value is matched multiple times, then a 400 error is reported (Errors/Multible Rows), and the error record is returned.

    The response body will contain the object of the updated record if the call is successful. Method returns an extended Application structure. Here, all foreign key fields are abstract object structures, utilizing AbstractText or AbstractLong data types, offering a detailed view of the data and related entities.

    Security
    OAuth

    oAuth autentication flow

    FlowClient Credentials
    Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Scopes:
    AccessManager:UpdateAllows to edit access groups and all related data. (ABAC) permissions required to perform a function.
    Path parameters
    Id
    stringRequired

    The identifier of the Application record. The parameter is part of the url address and some special characters are forbidden.

    You can extract any string to a base64 string. E.g email address name@domain.com value is base64|bmFtZUBkb21haW4uY29t

    Query parameters
    Name
    string

    The name of the database field. If empty, the entity Id field is used.

    Example:

    Name, ExternalId, ApplicationKey
    Body parameters

    Application information to update.

    The input parameter must be used in the ApplicationData record structure inside the FieldType parameter in the foreign key fields.

    object

    The record of Application information.

    Id
    string

    The identifier of the access application.

    Name
    string

    Name of application. The value must be unique in the system and you cannot add multiple values.

    ApplicationKey
    string

    The key used to identify the application must be unique within each workspace. The value must be unique in the system and you cannot add multiple values.

    ExternalId
    string

    The external system code of the application. The value must be unique in the system and you cannot add multiple values.

    Description
    string

    The description of access group.

    WebSiteURL
    string

    Web Site URL of application.

    Is_System
    boolean

    Defines if application is system (setting menu).

    Defaultfalse
    ExampleFalse
    Is_EndUser
    boolean

    Specifies whether the application is an end-user application.

    Defaultfalse
    ExampleFalse
    Is_Active
    boolean

    Defines if the application is active and can be used.

    Defaultfalse
    ExampleFalse
    Responses
    200

    Updated Application information.

    Expand All
    object

    The record of Application information.

    Id
    string

    The identifier of the access application

    Name
    string

    Name of application

    ApplicationKey
    string

    The key used to identify the application must be unique within each workspace.

    ExternalId
    string

    The external system code of the application

    Description
    string

    The description of access group

    WebSiteURL
    string

    Web Site URL of application

    Is_System
    boolean

    Defines if application is system (setting menu)

    Defaultfalse
    ExampleFalse
    Is_EndUser
    boolean

    Specifies whether the application is an end-user application

    Defaultfalse
    ExampleFalse
    Is_Active
    boolean

    Defines if the application is active and can be used

    Defaultfalse
    ExampleFalse
    ModifiedOn
    string (date-time)

    The date the record was updated

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    ModifiedBy
    object (AbstractLong)

    This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.

    Id
    integer (int64)

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Default0
    Example1234567891234567
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    CreatedBy
    object (AbstractLong)

    This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.

    Id
    integer (int64)

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Default0
    Example1234567891234567
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    CreatedOn
    string (date-time)

    The date the record was created

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    400

    Bad Request - The user has provided input that the browser is unable to convert.

    {
  "Errors": [
    "The user has provided input that the browser is unable to convert.",
    "There are multiple rows in the database for the same value",
    "The value does not match the specified entity structure",
    "..."
  ],
  "Type": "/Errors/Bad Input",
  "Title": "Bad Request",
  "StatusCode": 400,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    401

    Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

    {
  "Errors": [
    "The session Id or OAuth token used has expired or is invalid."
  ],
  "Type": "/Errors/Unauthorized",
  "Title": "Unauthorized",
  "StatusCode": 401,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    403

    Forbidden - The user does not have access to execute operation

    {
  "Errors": [
    "The user does not have access to execute operation"
  ],
  "Type": "/Errors/Permission",
  "Title": "Bad Request",
  "StatusCode": 403,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    500

    Internal Server Error - An internal server error is an error on the web server you're trying to access.

    {
  "Errors": [
    "An internal server error is an error on the web server you're trying to access."
  ],
  "Type": "/Errors/Internal Server Error",
  "Title": "Internal Server Error",
  "StatusCode": 500,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    Was this article helpful?
    What's Next
    Streamline your low-code application development processes to improve quality and productivity.

    Agile.Now


    Company


    Sales and Support

    © 2021 eSystems Nordic Oy - All rights reserved