Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Developers can retrieve master data through the YOUnite API.  The differences between YOUnite Data Store and federated  require different access patterns.

...

Code Block
languagejs
titleYOUnite Data Store GET /drs
{
    "drs": [
        {
            "uuid": "fbf6cfdf-d240-4843-9bd7-8e99ad7480c6",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Kabul\"},\"name\":\"Afghanistan\",\"countrycode\":\"AFG\"}"
        },
        {
            "uuid": "a9b1e4e1-fdf0-43e1-91f5-384c728cecee",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Luanda\"},\"name\":\"Angola\",\"countrycode\":\"AGO\"}"
        },
        {
            "uuid": "88c66722-8078-4e81-932f-d09f134d4130",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"The Valley\"},\"name\":\"Anguilla\",\"countrycode\":\"AIA\"}"
        },
        {
            "uuid": "c35c753a-a246-4959-97ca-bd108a9833c1",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Mariehamn\"},\"name\":\"Åland Islands\",\"countrycode\":\"ALA\"}"
        },
        {
            "uuid": "7c1c8a82-2de0-4719-b371-316536a9bf03",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Tirana\"},\"name\":\"Albania\",\"countrycode\":\"ALB\"}"
        },
        {
            "uuid": "124d861b-c5a9-4198-8724-760f1d7bcefb",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Abu Dhabi\"},\"name\":\"United Arab Emirates\",\"countrycode\":\"ARE\"}"
        },
        {
            "uuid": "87da0d10-d96f-4e7b-ade5-b3b7aa290ab2",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Yerevan\"},\"name\":\"Armenia\",\"countrycode\":\"ARM\"}"
        },
        {
            "uuid": "a5a5befa-89d9-4412-98e1-6278616ec3df",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Pago Pago\"},\"name\":\"American Samoa\",\"countrycode\":\"ASM\"}"
        },
        {
            "uuid": "aced6d65-de04-43e8-8993-8e5d0e7bc8aa",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Saint-Pierre, Réunion\"},\"name\":\"French Southern Territories\",\"countrycode\":\"ATF\"}"
        },
        {
            "uuid": "49025a51-9530-4cef-afc8-696ff97d1e1e",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"St Johns\"},\"name\":\"Antigua and Barbuda\",\"countrycode\":\"ATG\"}"
        }
    ],
    "_links": {
        "_self": {
            "href": "https://younite.ccc-tc.org/api/drs?filters=name%3Acountry%2Cversion%3A4&page=0&size=10"
        },
        "_next": {
            "href": "https://younite.ccc-tc.org/api/drs?filters=name%3Acountry%2Cversion%3A4&page=1&size=10"
        }
    }
}


If a domain version specified a drLabel then a request for a single master data record for a domain version can be made:

GET /drs?filters=country,version:4?filters=countrycode:ALB

Code Block
titleYOUnite Data Store GET a Single Master Data Record
{
    "drs": [
        {
            "uuid": "7c1c8a82-2de0-4719-b371-316536a9bf03",
            "created_by_uuid": "da823503-20e3-4505-922a-ae2ca319ef82",
            "json": "{\"capital\":{\"city\":\"Tirana\"},\"name\":\"Albania\",\"countrycode\":\"ALB\"}"
        }
    ],
    "_links": {
        "_self": {
            "href": "https://openmdm.dev.ccctechcenter.org/api/drs?filters=name%3Acountry%2Cversion%3A4%2CdrLabel%3AALB&page=0&size=10"
        }
    }
}

Federated Access Patterns

...

TODO fix callbackURL

POST /drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler

Code Block
languagejs
titleRequest Payload
{
	"callbackUrl": "https://production.ccc-co.org/data/6c5a754b-6ce0-4871-8dec-d39e255eccc3/drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler",
	"zoneUuid": "6c5a754b-6ce0-4871-8dec-d39e255eccc3",
	"timeout": 10,
	"notificationRegistrationType": "WEB_SOCKET"
}

...

To check if YOUnite server has an adaptor-to-domain-entry link for a given master data record at an adaptor. 

GET /drs/{uuid}/adaptor/{adaptorUuid}/check

...