Library Entity Attributes

/api/repositories/(string:repository)/library/entities/(int:libraryID)/attributes

Parameter	Type	Purpose
repository	string	The Repository name
library	int	The library ID

Show

GET /api/repositories/(string: repository)/library/entities/(int: libraryID)/attributes

Get a list of all attributes for Library Entity. The GET request supports page and pageSize parameters on the URL. If you require a subset of this data (filtering, sorting, or columns), POST to this url with the standard request body.

GET /api/repositories/jupiter/library/entities/1/attributes HTTP/1.1
Accept: application/json

Response Code	Reason
200	Success
500	Server error

The response will be a Standard Response, with a list of the attributes in the Library Entity.

The columns array will contain a list of the columns for each row:

Human Name	Column Name	Description
ID	model_entity_id	Internal entity reference
ID	model_attribute_id	Internal entity reference
Name	name	The schema name for the library entity
Description	description	Business Description
Attributes Used	attr_used	Boolean flag to show if the attribute is used
Created By	CREATED_BY	User who created the attribute
Date Created	_created_date	When the attribute was created
Edited By	EDITED_BY	The user who last edited the attribute
Edited Date	_edited_date	When the attribute was last edited

Each data row contains the data for a single attribute; the metadata contains the URL to drill-down to the attribute:

{
    "dataRow": [
        "2",
        "1",
        "Sales Person",
        "",
        "bob",
        "2014/11/13 11:55:01",
        "bob",
        "2014/11/13 11:55:01"
    ],
    "metadata": {
        "url": "/api/repositories/jupiter/library/entities/2/attributes/1"
    }
}

Show Some

POST /api/repositories/(string: repository)/library/entities/(int: libraryID)/attributes

Get a list of all attributes for Library Entity that match various criteria

JSON Parameters:  

• body – The request body

POST /api/repositories/jupiter/library/entities/1/attributes HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "where": "Name = \"Status\""
    }
}

The request requires a Standard Request packet. see the get command for the contents of the request..

The response will contain a list of library entity attributes matching the given criteria.

Add

POST /api/repositories/(string: repository)/library/entities/(int: libraryID)/attributes

Adds 1 or more attributes to the library.

JSON Parameters:  

• body – The request body

The request requires a Standard Request packet.

POST /api/repositories/test/library/entities/1/attributes
{
    "command": "add",
    "data": [
        {
            "name": "newattr1",
            "description": "a new attribute"
        },
        {
            "name": "newattr2",
            "description": "another new attribute"
        }
            ]
}

Response Code	Reason
200	Success
500	Server error