Open APIs

Expand all | Collapse all

External IDs of resources

  • 1.  External IDs of resources

    TM Forum Member
    Posted 26 days ago
    Hi,

    I was wondering how I should deal with the external IDs of some resources such as Agreement.
    Agreement as a resource has a unique identifier. We can imagine there are multiple systems storing Agreement items (1 for GSM, 1 for FTTx for instance), case in which we would have the Agreement resource ID related to the system storing it.
    Considering the above I was thinking would be useful to have a list of external IDs which would include a list of IDs of the resource in a specific system. What is your opinion on that? Do you have a solution already for that?

    Thanks,
    Calin

    ------------------------------
    Calin Mates
    Aplication Architect
    IBM Corporation
    ------------------------------


  • 2.  RE: External IDs of resources

    TM Forum Member
    Posted 20 days ago

    Hi Calin

    You will be pleased to learn that we recently introduced a full ExternalIdentifier pattern into the Open API, which does answer your need. It will probably take time for the concept to be adopted in all relevant places, and input from the community will no doubt be helpful here.
    Its recommended use looks like this:
    "externalIdentifier": {
    "type": "array",
    "items": {
    "$ref": "../Common/ExternalIdentifier.schema.json#/definitions/ExternalIdentifier"
    }
    },
    and the structure itself looks like this:
    "properties": {
    "owner": {
    "type": "string",
    "description": "Name of the external system that owns the entity.",
    "examples": [
    "MagentoCommerce"
    ]
    },
    "externalIdentifierType": {
    "type": "string",
    "description": "Type of the identification, typically would be the type of the entity within the external system",
    "examples": [
    "ProductOrder"
    ]
    },
    "id": {
    "type": "string",
    "description": "identification of the entity within the external system.",
    "examples": [
    "MC2255771199555"
    ]
    }
    },



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------