Update Resource

Update Resource updates a resource in Guardian

Path Parameters

id string required

application/json

Request Body required

id string

Resource unique identifier

providerType string

Type of the provider that manages this resource

providerUrn string

Unique resource urn

type string

Type of the resource. Depends on the provider type. For example, for BigQuery, it can be dataset, table, view, etc.

urn string

Unique resource urn

name string
details object

Additional information of the resource that can be updated from Guardian

labels object
property name* string
createdAt date-time

Resource creation timestamp

updatedAt date-time

Resource last update timestamp

isDeleted boolean

Whether the resource is deleted or not

parentId string

Parent resource id

children object[]
List of child resources
Array [
0
1
2
3
4
5
6
7
8
9
]

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

resource object
id string
Resource unique identifier
providerType string
Type of the provider that manages this resource
providerUrn string
Unique resource urn
type string
Type of the resource. Depends on the provider type. For example, for BigQuery, it can be dataset, table, view, etc.
urn string
Unique resource urn
name string
details object
Additional information of the resource that can be updated from Guardian
labels object
property name* string
createdAt date-time
Resource creation timestamp
updatedAt date-time
Resource last update timestamp
isDeleted boolean
Whether the resource is deleted or not
parentId string
Parent resource id
children object[]
List of child resources
Array [
0
1
2
3
4
5
6
7
8
9
]

{
  "resource": {
    "id": "f4b7a3c0-9f9b-4b9b-9b0a-9e4b1a1b1b1b",
    "providerType": "bigquery",
    "providerUrn": "my-bq",
    "type": "table",
    "urn": "string",
    "name": "string",
    "details": {},
    "labels": {},
    "createdAt": "2023-06-07T05:39:56.961Z",
    "updatedAt": "2023-06-07T05:39:56.961Z",
    "isDeleted": true,
    "parentId": "string",
    "children": [
      {}
    ]
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...