domain-identity-flag_types

Identity flag_types

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/identity/flag_types

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/ GET

domain-identity-flag_types

POST

flag_types

/{flag_type} DELETE

domain-identity-flag_types-by-name

GET

domain-identity-flag_types-by-name

PUT

domain-identity-flag_types-by-name

/{flag_type}/logs GET

Get a group of logs for a specific flag name

Paths

domain-identity-flag_types

GET /

domain-identity-flag_types

flag_types_query

flag_types query parameter.

query string
page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

A collection of flag_types

Example for application/json
{
"links": {
"flag_types__create": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1",
"method": "POST",
"rel": "flag_types__create"
}
,
"flag_types__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"flag_types__next": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "flag_types__next"
}
,
"flag_types__prev": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "flag_types__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
}
,
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
}
,
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"name": "HOLD"
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found

There is no matching flag_types

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

flag_types

POST /

Creates a flag type

New flag_types values

Uses default content-types: application/json

201 Created

flag type successfully created

Example for application/json
{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
},
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
},
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"name": "HOLD"
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

domain-identity-flag_types-by-name

DELETE /{flag_type}

delete a flag type

flag_type

flag_type name parameter.

path string

Uses default content-types: application/json

204 No Content

flag type successfully deleted

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

domain-identity-flag_types-by-name

GET /{flag_type}

domain-identity-flag_types-by-name

flag_type

flag_type name parameter.

path string

Uses default content-types: application/json

200 OK

A collection of flag_type

Example for application/json
{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
},
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
},
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"name": "HOLD"
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found

There is no matching flag_types

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

domain-identity-flag_types-by-name

PUT /{flag_type}

modify a flag type

flag_type

flag_type name parameter.

path string

Uses default content-types: application/json

200 OK

flag type successfully modified

Example for application/json
{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
},
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
},
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"name": "HOLD"
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get a group of logs for a specific flag name

GET /{flag_type}/logs

Tags: Logs

Retrieve the collection of logs for a relationship type

flag_type

the flag type

path string #/parameters/flag_type
page_size

Return this many items of a large collection

query string #/parameters/page_size
page_start

Skip into a large collection to this item

query string #/parameters/page_start

Uses default content-types: application/json

200 OK

A collection of flag name logs

Example for application/json
{
"links": {
"flag_type_logs__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"flag_type_logs__next": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=101&page_size=50",
"method": "GET",
"rel": "flag_type_logs__next"
}
,
"flag_type_logs__prev": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=1&page_size=50",
"method": "GET",
"rel": "flag_type_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"explanation": "new flag type",
"log_action": "flag_type__create",
"name": "HOLD"
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found

There is no matching relationship type

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Parameter definitions

flag_type flag_type

the flag type

path string
page_start page_start

Skip into a large collection to this item

query string
page_size page_size

Return this many items of a large collection

query string

Response definitions

400

Invalid Request - unable to interpret request

401

Authentication required to access data

403

Access denied to protected data

409

Query parameters conflict or are malformed

default

Unexpected error

Schema definitions

error: object

Error body

metadata: simple_metadata

explanation: string

Who created the flag_types?

"Allow no further processes until this matter is resolved."                            

flag_type: object

A flag type

{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
}
,
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
}
,
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"name": "HOLD"
}
links: object

Hypermedia Links that this domain-identity-flag_types

flag_type__info: object

Hypermedia link to retrieve this domain-identity-flag_types

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/v1/:flag_type
method: string , x ∈ { GET (default) }
flag_type__modify: object

Hypermedia link to modify some domain-identity-flag_types

rel: string flag_types__modify
href: string https://api.byu.edu/domains/identity/flag_types/v1/:flag_type
method: string , x ∈ { PUT (default) }
flag_type__remove: object

Hypermedia link to remove an domain-identity-flag_types

rel: string flag_types__remove
href: string https://api.byu.edu/domains/identity/flag_types/v1/:flag_type
method: string , x ∈ { DELETE (default) }
metadata: simple_metadata
name: name
explanation: explanation

flag_type_log: object

Change Log for flag type API

log_action: log_action
name: name
explanation: explanation

flag_type_logs: object

Change logs for flag typ API

{
"links": {
"flag_type_logs__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"flag_type_logs__next": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=101&page_size=50",
"method": "GET",
"rel": "flag_type_logs__next"
}
,
"flag_type_logs__prev": {
"href": "https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=1&page_size=50",
"method": "GET",
"rel": "flag_type_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"explanation": "new flag type",
"log_action": "flag_type__create",
"name": "HOLD"
}
]
}
links: object

Hypermedia Link that impact the log collection for flag_type

flag_type_logs__info: object
rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=51&page_size=50
method: string , x ∈ { GET (default) }
flag_type_logs__prev: object
rel: string , x ∈ { flag_type_logs__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=1&page_size=50
method: string , x ∈ { GET (default) }
flag_type_logs__next: object
rel: string , x ∈ { flag_type_logs__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/flag_type?page_start=101&page_size=50
method: string , x ∈ { GET (default) }
metadata: sub_level_metadata
values: object[]

flag_type_new: object

Elements required to add a new flag_types

{
"explanation": "new flag type.",
"name": "HOLD"
}
name: name
explanation: explanation

flag_types: object

The flag_types collection

{
"links": {
"flag_types__create": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1",
"method": "POST",
"rel": "flag_types__create"
}
,
"flag_types__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"flag_types__next": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "flag_types__next"
}
,
"flag_types__prev": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "flag_types__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"explanation": "Allow no further processes until this matter is resolved.",
"links": {
"flag_type__info": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "GET",
"rel": "self"
}
,
"flag_type__modify": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "PUT",
"rel": "flag_types__modify"
}
,
"flag_type__remove": {
"href": "https://api.byu.edu/domains/identity/flag_types/v1/111111111",
"method": "DELETE",
"rel": "flag_types__remove"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"name": "HOLD"
}
]
}
links: object

Hypermedia Links that impact the flag_types collection

flag_types__info: object
rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/v1?page_start=51&page_size=50
method: string , x ∈ { GET (default) }
flag_types__prev: object
rel: string , x ∈ { flag_types__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/v1?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
flag_types__next: object
rel: string , x ∈ { flag_types__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }
flag_types__create: object
rel: string , x ∈ { flag_types__create (default) }
href: string (uri) https://api.byu.edu/domains/identity/flag_types/v1
method: string , x ∈ { POST (default) }
metadata: sub_level_metadata
values: object[]

log_action: string

"flag_type__create"                            

name: string

A flag type

"HOLD"                            

simple_metadata: object

cache: object

If data is from live source, value will be null, otherwise it will be date-time of cache

date_time: string (date-time)
validation_response: validation_response

sub_level_metadata:

collection_size: integer , { x ∈ ℤ | x ≥ 0 }
page_start: integer , { x ∈ ℤ | x ≥ 0 }
page_end: integer , { x ∈ ℤ | x ≥ 0 }
page_size: integer , { x ∈ ℤ | x ≥ 1 }
default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
max_page_size: integer

validation_response: object

return_code: integer
response: string
Service Path: 
/domains/identity/flag_types
Domain or University API: 
/domains/identity/flag_types

Community

 

Don't see your question listed here? Ask!