TagREST Resource

PUT /tags/importservicetags

Request Body
media type data type
application/json ServiceTags (JSON)
application/xml serviceTags (XML)

Example

Request
PUT /tags/importservicetags
Content-Type: application/json

                
{
  "serviceName" : "...",
  "tagUpdateTime" : 12345,
  "resourceToTagIds" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "tagDefinitions" : {
    "property1" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "isDelta" : true,
  "tags" : {
    "property1" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "tagsChangeExtent" : "NONE",
  "serviceResources" : [ {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  }, {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  } ],
  "op" : "...",
  "tagVersion" : 12345
}
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/resources

Response Body
media type data type description
application/json array of RangerServiceResource (JSON)
application/xml list of rangerServiceResource (XML)

Example

Request
GET /tags/resources
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

POST /tags/resources

Request Parameters
name type description default constraints
updateIfExists query true boolean
Request Body
media type data type
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
POST /tags/resources
Content-Type: application/json
Accept: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/tagdefs

Response Body
media type data type description
application/json array of RangerTagDef (JSON)
application/xml list of rangerTagDef (XML)

Example

Request
GET /tags/tagdefs
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

POST /tags/tagdefs

Request Parameters
name type description default constraints
updateIfExists query true boolean
Request Body
media type data type
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)
Response Body
media type data type description
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)

Example

Request
POST /tags/tagdefs
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/tagresourcemaps

Request Parameters
name type description
resource-guid query
tag-guid query

Example

Request
DELETE /tags/tagresourcemaps
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tagresourcemaps

Response Body
media type data type description
application/json array of RangerTagResourceMap (JSON)
application/xml list of rangerTagResourceMap (XML)

Example

Request
GET /tags/tagresourcemaps
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "tagId" : 12345,
  "resourceId" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

POST /tags/tagresourcemaps

Request Parameters
name type description default constraints
lenient query false boolean
resource-guid query    
tag-guid query    
Response Body
media type data type description
application/json RangerTagResourceMap (JSON)
application/xml rangerTagResourceMap (XML)

Example

Request
POST /tags/tagresourcemaps
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "tagId" : 12345,
  "resourceId" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/tags

Response Body
media type data type description
application/json array of RangerTag (JSON)
application/xml list of rangerTag (XML)

Example

Request
GET /tags/tags
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

POST /tags/tags

Request Parameters
name type description default constraints
updateIfExists query true boolean
Request Body
media type data type
application/json RangerTag (JSON)
application/xml rangerTag (XML)
Response Body
media type data type description
application/json RangerTag (JSON)
application/xml rangerTag (XML)

Example

Request
POST /tags/tags
Content-Type: application/json
Accept: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/types

Response Body
media type data type description
application/json array of string (JSON)
application/xml list of string (XML)

Example

Request
GET /tags/types
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /tags/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
lastActivationTime query 0 long
lastKnownVersion query   long
pluginCapabilities query  
pluginId query    
supportsTagDeltas query false boolean
Response Body
media type data type description
application/json ServiceTags (JSON)
application/xml serviceTags (XML)

Example

Request
GET /tags/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "serviceName" : "...",
  "tagUpdateTime" : 12345,
  "resourceToTagIds" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "tagDefinitions" : {
    "property1" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "isDelta" : true,
  "tags" : {
    "property1" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "tagsChangeExtent" : "SERVICE_RESOURCE",
  "serviceResources" : [ {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  }, {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  } ],
  "op" : "...",
  "tagVersion" : 12345
}
                
              

DELETE /tags/resource/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /tags/resource/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/resource/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
GET /tags/resource/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

PUT /tags/resource/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
PUT /tags/resource/{id}
Content-Type: application/json
Accept: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/server/tagdeltas

Request Parameters
name type description default constraints
days query 3 int

Example

Request
DELETE /tags/server/tagdeltas
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /tags/tag/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /tags/tag/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tag/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerTag (JSON)
application/xml rangerTag (XML)

Example

Request
GET /tags/tag/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

PUT /tags/tag/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json RangerTag (JSON)
application/xml rangerTag (XML)
Response Body
media type data type description
application/json RangerTag (JSON)
application/xml rangerTag (XML)

Example

Request
PUT /tags/tag/{id}
Content-Type: application/json
Accept: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/tagdef/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /tags/tagdef/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tagdef/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)

Example

Request
GET /tags/tagdef/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

PUT /tags/tagdef/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)
Response Body
media type data type description
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)

Example

Request
PUT /tags/tagdef/{id}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/tagresourcemap/tag-resource-guid

Request Parameters
name type description
resourceGuid query
tagGuid query
Response Body
media type data type description
application/json RangerTagResourceMap (JSON)
application/xml rangerTagResourceMap (XML)

Example

Request
GET /tags/tagresourcemap/tag-resource-guid
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagId" : 12345,
  "resourceId" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/tagresourcemap/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /tags/tagresourcemap/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tagresourcemap/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerTagResourceMap (JSON)
application/xml rangerTagResourceMap (XML)

Example

Request
GET /tags/tagresourcemap/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagId" : 12345,
  "resourceId" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/resource/guid/{guid}

Request Parameters
name type description default constraints
guid path    
deleteReferences query false boolean

Example

Request
DELETE /tags/resource/guid/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/resource/guid/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
GET /tags/resource/guid/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

PUT /tags/resource/guid/{guid}

Request Parameters
name type description
guid path
Request Body
media type data type
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
PUT /tags/resource/guid/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/resources/service/{serviceName}

Request Parameters
name type description
serviceName path
Response Body
media type data type description
application/json array of RangerServiceResource (JSON)
application/xml list of rangerServiceResource (XML)

Example

Request
GET /tags/resources/service/{serviceName}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

GET /tags/secure/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
lastActivationTime query 0 long
lastKnownVersion query   long
pluginCapabilities query  
pluginId query    
supportsTagDeltas query false boolean
Response Body
media type data type description
application/json ServiceTags (JSON)
application/xml serviceTags (XML)

Example

Request
GET /tags/secure/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "serviceName" : "...",
  "tagUpdateTime" : 12345,
  "resourceToTagIds" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "tagDefinitions" : {
    "property1" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "name" : "...",
      "source" : "...",
      "attributeDefs" : [ {
        "name" : "...",
        "type" : "..."
      }, {
        "name" : "...",
        "type" : "..."
      } ],
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "isDelta" : true,
  "tags" : {
    "property1" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    },
    "property2" : {
      "validityPeriods" : [ {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      }, {
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "timeZone" : "...",
        "endTime" : "..."
      } ],
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "owner" : 12345,
      "createTime" : 12345,
      "id" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "updateTime" : 12345,
      "isEnabled" : true
    }
  },
  "tagsChangeExtent" : "TAGS",
  "serviceResources" : [ {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  }, {
    "resourceElements" : {
      "property1" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      },
      "property2" : {
        "values" : [ "...", "..." ],
        "isRecursive" : true,
        "isExcludes" : true
      }
    },
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "serviceName" : "...",
    "resourceSignature" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  } ],
  "op" : "...",
  "tagVersion" : 12345
}
                
              

DELETE /tags/tag/guid/{guid}

Request Parameters
name type description
guid path

Example

Request
DELETE /tags/tag/guid/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tag/guid/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json RangerTag (JSON)
application/xml rangerTag (XML)

Example

Request
GET /tags/tag/guid/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

PUT /tags/tag/guid/{guid}

Request Parameters
name type description
guid path
Request Body
media type data type
application/json RangerTag (JSON)
application/xml rangerTag (XML)
Response Body
media type data type description
application/json RangerTag (JSON)
application/xml rangerTag (XML)

Example

Request
PUT /tags/tag/guid/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/tagdef/guid/{guid}

Request Parameters
name type description
guid path

Example

Request
DELETE /tags/tagdef/guid/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tagdef/guid/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)

Example

Request
GET /tags/tagdef/guid/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/tagdef/name/{name}

Request Parameters
name type description
name path
Response Body
media type data type description
application/json RangerTagDef (JSON)
application/xml rangerTagDef (XML)

Example

Request
GET /tags/tagdef/name/{name}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "source" : "...",
  "attributeDefs" : [ {
    "name" : "...",
    "type" : "..."
  }, {
    "name" : "...",
    "type" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

DELETE /tags/tagresourcemap/guid/{guid}

Request Parameters
name type description
guid path

Example

Request
DELETE /tags/tagresourcemap/guid/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tags/tagresourcemap/guid/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json RangerTagResourceMap (JSON)
application/xml rangerTagResourceMap (XML)

Example

Request
GET /tags/tagresourcemap/guid/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagId" : 12345,
  "resourceId" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

GET /tags/tags/type/{type}

Request Parameters
name type description
type path
Response Body
media type data type description
application/json array of RangerTag (JSON)
application/xml list of rangerTag (XML)

Example

Request
GET /tags/tags/type/{type}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "validityPeriods" : [ {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  }, {
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "timeZone" : "...",
    "endTime" : "..."
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "type" : "...",
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "owner" : 12345,
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
} ]
                
              

GET /tags/resource/service/{serviceName}/signature/{resourceSignature}

Request Parameters
name type description
resourceSignature path
serviceName path
Response Body
media type data type description
application/json RangerServiceResource (JSON)
application/xml rangerServiceResource (XML)

Example

Request
GET /tags/resource/service/{serviceName}/signature/{resourceSignature}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resourceElements" : {
    "property1" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    },
    "property2" : {
      "values" : [ "...", "..." ],
      "isRecursive" : true,
      "isExcludes" : true
    }
  },
  "additionalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "ownerUser" : "...",
  "serviceName" : "...",
  "resourceSignature" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}