System Logs Endpoint

GET /api/v3/tenants/{idTenant}/system-logs

This endpoint now supports the following options:

• Return a different page size
• Return a different page
• Return a different page controlling the page size
• Filter the list by different criteria
• Sort the list by different criteria
• Return different types of data without time limitations
• Return different timeframes

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs
Accept: application/json
Returns:
{
  "__self__": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
  "offset": 0,
  "limit": 100,
  "totalCount": 747,
  "first": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
    "title": "First",
    "deleted": false,
    "count": 100
  },
  "next": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=100&limit=100",
    "title": "Next",
    "deleted": false,
    "count": 100
  },
  "last": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=700&limit=100",
    "title": "Last",
    "deleted": false,
    "count": 47
  },
  "items": [
    {
      "description": "Log in successful",
      "timestamp": "2019-11-12T14:56:14.259-05:00",
      "action": "Log In",
      "details": [],
      "user": {
        "link": "/api/v3/users/userId",
        "urn": "urn:adsk.plm:tenant.user:TENANTNAME.userId",
        "title": "John Doe",
        "status": "Active",
        "email": "john.doe@autodesk.com",
        "image": {
          "small": "location 1",
          "medium": "location 2",
          "large": "location 3"
        }
      }
    },

Back to top

Optional query parameters

All these query parameters can be combined.

Return a different page size

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?limit=value

Return a different page

The offset refers to the number of entries skipped, therefore returning the next set by the limit (default set to 100). In this example, the first 100 entries will be skipped, returning the subsequent 100.

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?offset=value

Return a different page controlling the page size

Using the two query parameters above, this request will skip the first 100 entries, and return the next 50 entries (effectively, the third page in the whole set).

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?limit=50&offset=100

Back to top

Filter the list by different criteria

This functionality allows adding a query parameter to the GET call to filter the list matching on the supplied query parameters. The following fields are supported:

• user.title (user’s display name)
• user.email
• user.id
• description

The filtering format follows Autodesk Platform Services standards, and it is summarized in the example below.

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?filter[user.title]=John
{
  "__self__": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
  "offset": 0,
  "limit": 100,
  "totalCount": 1,
  "first": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
    "title": "First",
    "deleted": false,
    "count": 1
  },
  "next": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
    "title": "Next",
    "deleted": false,
    "count": 1
  },
  "last": {
    "link": "/api/v3/tenants/TENANTNAME/system-logs?offset=0&limit=100",
    "title": "Last",
    "deleted": false,
    "count": 1
  },
  "items": [
    {
      "description": "Log in successful",
      "timestamp": "2019-11-12T14:56:14.259-05:00",
      "action": "Log In",
      "details": [],
      "user": {
        "link": "/api/v3/users/userId",
        "urn": "urn:adsk.plm:tenant.user:TENANTNAME.userId",
        "title": "John Doe",
        "status": "Active",
        "email": "john.doe@autodesk.com",
        "image": {
          "small": "location 1",
          "medium": "location 2",
          "large": "location 3"
        }
      }
    }
}

Back to top

Sort the list by different criteria

This functionality allows adding a query parameter to the GET call to sort the list matching on the supplied query parameters – ascending or descending order. The following fields are supported:

• date (timestamp)
• description
• user.title

The sorting format is summarized in the example below.

GET https:// tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?sort=timestamp asc
Header:
Accept: application/json
Returns:
(Same as above, sorted by the specific criteria)

Return different types of data without time limitations

This functionality allows returning all system log entries since the tenant was created (instead of limited to 60 days when returning mixed values, without a parameter) when specifying a specific log type. The following types are supported:

• /system-logs?type=item (all item-related information)
• /system-logs?type=system (all system-related information)

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?type=item&limit=1000

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?type=system&limit=1000

Back to top

Return different timeframes

This functionality allows returning all system log entries based on different time spans (default is 60 days when parameters are not supplied).

• system-logs?filter[from.date]=YYYY-MM-DD&filter[to.date]=YYYY-MM-DD

GET https://tenant_name.autodeskplm360.net/api/v3/tenants/{idTenant}/system-logs?filter[from.date]=YYYY-MM-DD&filter[to.date]=YYYY-MM-DD

Back to top