Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "actionName": "asset",
  "response": {
    "createdId": "10004"
  },
  "status": 201,
  "time": 1435
}
Code Block


Security

The create action of RESTAPI domain allows to manage the endpoint call authorization.
There are two parameters:

...

  • actionName: Character string, action identifier

  • id (or form_id): Identifier of current instance

  • action: Identifier or name of the action to be applied

Security

The workflow_do action of RESTAPI domain allows the management of the endpoint call authorization.
There are two parameters:

...

Code Block
{
    "actionName": "asset",
    "response": [
        {
            "id": "1444",
            "locked": true,
            "owner": "user122"
        },
        {
            "id": "1051",
            "locked": false,
            "owner": null
        },
    ],
    "status": 200,
    "time": 44
}

Security

The locks_get action of RESTAPI domain allows the management of the endpoint call authorization.
There are two parameters:

...

  • in case of error, the status is error and info is the error message. The current lock status is null if the error occurred when querying the current lock status.

  • if the instance was not locked and becomes locked, the status is locked and the info is the name of the owner of the lock (the user who is invoking the service)

  • if the instance was already locked by the calling user, the lock is extended, and the status is lock extended

  • if the instance was locked but by another user, the status is already locked and info is the current owner’s name

Security

The lock action of RESTAPI domain allows the management of the endpoint call authorization.
There are two parameters:

...

  • in case of error, the status is error and info is the error message. The current lock status is null if the error occurred when querying the current lock status.

  • if the instance wasn’t locked, the status is not locked and the info is null.

  • if the instance was locked by the calling user, the status is unlocked the info is null

  • if the instance was locked but by another user, the status is not owner and info is the current owner’s name

Security

The unlock action of RESTAPI domain allows the management of the endpoint call authorization.
There are two parameters:

...

Code Block
{
  "catalog": "List of modification action, creation and workflow actions",
  "request": {
    "parameters": {
      "headers": "true"
    }
  },
  "response": {
    "data": [ {
      "name": "name of the action",
      "actions": [ // Possible actions (create, update, patch, workflow)
        "update",
        "workflow"
      ],
      "view": "default view to get the properties",
      "properties": [ "name of property 1", "name of property 2", "name of property 3" ],
      "headers": {
        "name of the property": {
          "name": "localized label of the property",
          "type": "type of the property"
        },
        "name ot the resource type property": {
          "name": "localized label of the property",
          "type": "resource",
          "attachment": true, // true or false if the file is in attachment or not
        }
      }
    }
    ],
    "links": {
      "href": "http://host:port/app/_plugins/WXM_RESTAPI/page/catalog/updateaction.jspz?headers=true"
    },
    "status": 200,
    "time": 131
  }
}

Security

The catalog action of RESTAPI domain allows the management of the endpoint call authorization.
There are two parameters:

...