Open APIs

Good afternoon.
We use the data model "Entity" to describe the specification and characteristics.
TMF662_Entity_Catalog_Management_API_User_Guide_v4.0.0.pdf
Can you please tell me how to specify the type of characteristic for the specification? Examples?
Characteristic values are different objects, how to describe this?
How, depending on the selected type of characteristic, to choose the desired structure of the value object?
All "value objects" have a different structure, depending on the type of characteristic.

In this example:





Where to specify the "type of characteristic" ("specCharacteristic")? How to describe different "Value object", depending on the "characteristic type"? ValueType = object, what next? "object" have a different structure.

------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------

I got some answers here https://engage.tmforum.org/communities/community-home/digestviewer/viewthread?GroupId=31&MessageKey=06abec6e-393f-4729-9f9e-cf6cec91c8d5&CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5&tabReturn2%community%viewer -home%2fdigestviewer%3fcommunitykey%3dd543b8ba-9d3a-4121-85ce-5b68e6c31ce5%26tab%3ddigestviewer#bm06abec6e-393f-4729-9f9e-cf6cec91c8d5

But from the examples, it is not clear which approach to use:

1. With "valueType : object"
{
"name": "Equipment",
"valueType": "object",
"value": {
"@type": "Equipment",
"serialNumber": "12444545544",
"versionNumber": "1.22",
"manufactureDate": "05-04-2017"
},
"@schemaLocation": "http://serverlocation:port/partyManagement/schema/Equipment.yml"
}​

or

 "serviceCharacteristic": [
        {
            "name": "vCPE_IP",
            "valueType": "object",
            "value": {
                "@type": "IPAddress",
                "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/IPAddress.schema.json",
                "address": "193.218.236.21"
            }
        }

or

3. With "@type": "ObjectCharacteristicValue"
"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus",
"contactMedium": {
"emailAddress": "jean.pontus@orange.fr"
},
}
]

I need to describe such a model.
How to describe such a characteristic (the structure of objects is different)?:

"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus"
}
},
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"model": "BMW",
"number" : "525"
}
}

Both values are objects, how to describe them then with @type or valueType ObjectCharacteristicValue? Can there be such types as NameCharacteristicValue and autoCharacteristicValue?



------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------

Original Message:
Sent: Dec 07, 2022 07:19
From: Pedan Andrey
Subject: TMF662 types characteristic

Good afternoon.
We use the data model "Entity" to describe the specification and characteristics.
TMF662_Entity_Catalog_Management_API_User_Guide_v4.0.0.pdf
Can you please tell me how to specify the type of characteristic for the specification? Examples?
Characteristic values are different objects, how to describe this?
How, depending on the selected type of characteristic, to choose the desired structure of the value object?
All "value objects" have a different structure, depending on the type of characteristic.

In this example:

"specCharacteristic": [ { "name": "Platform", "id": "4441", "description": "This characteristic describes the platform of the node", "valueType": "string", "configurable": true, "validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "@valueSchemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/StringCharacteristic.schema.json", "minCardinality": 0, "maxCardinality": 1, "isUnique": true, "regex": "", "extensible": false,
"characteristicValueSpecification":
[ { "valueType": "string", "isDefault": true,
"value": "Windows",
"validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "regex": "", "valueFrom": "", "valueTo": "", "unitOfMeasure": "", "rangeInterval": "open", "@type": "CharacteristicValueSpecification", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/CharacteristicValueSpecification.schema.json" } ], "charSpecRelationship": [], "@type": "SpecCharacteristic", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/SpecCharacteristic.schema.json" } ],

Where to specify the "type of characteristic" ("specCharacteristic")? How to describe different "Value object", depending on the "characteristic type"? ValueType = object, what next? "object" have a different structure.

------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------

Can I define my class like autoCharacteristicValue?
Is this description correct?

"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "nameCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus"
}

or

{
"name": "Equipment",
"valueType": "autoCharacteristicValue",
"value": {
"@type": "Equipment",
"serialNumber": "12444545544",
"versionNumber": "1.22",
"manufactureDate": "05-04-2017"
},


------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------

Original Message:
Sent: Dec 08, 2022 01:37
From: Pedan Andrey
Subject: TMF662 types characteristic

I got some answers here https://engage.tmforum.org/communities/community-home/digestviewer/viewthread?GroupId=31&MessageKey=06abec6e-393f-4729-9f9e-cf6cec91c8d5&CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5&tabReturn2%community%viewer -home%2fdigestviewer%3fcommunitykey%3dd543b8ba-9d3a-4121-85ce-5b68e6c31ce5%26tab%3ddigestviewer#bm06abec6e-393f-4729-9f9e-cf6cec91c8d5

But from the examples, it is not clear which approach to use:

1. With "valueType : object"
{
"name": "Equipment",
"valueType": "object",
"value": {
"@type": "Equipment",
"serialNumber": "12444545544",
"versionNumber": "1.22",
"manufactureDate": "05-04-2017"
},
"@schemaLocation": "http://serverlocation:port/partyManagement/schema/Equipment.yml"
}​

or

 "serviceCharacteristic": [
        {
            "name": "vCPE_IP",
            "valueType": "object",
            "value": {
                "@type": "IPAddress",
                "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/IPAddress.schema.json",
                "address": "193.218.236.21"
            }
        }

or

3. With "@type": "ObjectCharacteristicValue"
"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus",
"contactMedium": {
"emailAddress": "jean.pontus@orange.fr"
},
}
]

I need to describe such a model.
How to describe such a characteristic (the structure of objects is different)?:

"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus"
}
},
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"model": "BMW",
"number" : "525"
}
}

Both values are objects, how to describe them then with @type or valueType ObjectCharacteristicValue? Can there be such types as NameCharacteristicValue and autoCharacteristicValue?



------------------------------
Pedan Andrey
TO BE VERIFIED

Original Message:
Sent: Dec 07, 2022 07:19
From: Pedan Andrey
Subject: TMF662 types characteristic

Good afternoon.
We use the data model "Entity" to describe the specification and characteristics.
TMF662_Entity_Catalog_Management_API_User_Guide_v4.0.0.pdf
Can you please tell me how to specify the type of characteristic for the specification? Examples?
Characteristic values are different objects, how to describe this?
How, depending on the selected type of characteristic, to choose the desired structure of the value object?
All "value objects" have a different structure, depending on the type of characteristic.

In this example:

"specCharacteristic": [ { "name": "Platform", "id": "4441", "description": "This characteristic describes the platform of the node", "valueType": "string", "configurable": true, "validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "@valueSchemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/StringCharacteristic.schema.json", "minCardinality": 0, "maxCardinality": 1, "isUnique": true, "regex": "", "extensible": false,
"characteristicValueSpecification":
[ { "valueType": "string", "isDefault": true,
"value": "Windows",
"validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "regex": "", "valueFrom": "", "valueTo": "", "unitOfMeasure": "", "rangeInterval": "open", "@type": "CharacteristicValueSpecification", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/CharacteristicValueSpecification.schema.json" } ], "charSpecRelationship": [], "@type": "SpecCharacteristic", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/SpecCharacteristic.schema.json" } ],

Where to specify the "type of characteristic" ("specCharacteristic")? How to describe different "Value object", depending on the "characteristic type"? ValueType = object, what next? "object" have a different structure.

------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------

Hi Pedan

Sorry for the late reply.  SID suggests to use the characteristicRelationship pattern for this as described below, but did you come up with an alternative mechanism?

Each tab, Features, Description, Additional Info, and Shipping Info is an instance of CharacteristicSpecification.  The Features CharacteristicSpec is a composite that is comprised of an instance of CharacteristicSpec for each feature line.  Instances of the CharacteristicSpecRelationship are used to compose the Features of the instances of feature line.

------------------------------
Dan d'Albuquerque
Entronica Company Limited
------------------------------

Original Message:
Sent: Dec 08, 2022 01:52
From: Pedan Andrey
Subject: TMF662 types characteristic

Can I define my class like autoCharacteristicValue?
Is this description correct?

"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "nameCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus"
}

or

{
"name": "Equipment",
"valueType": "autoCharacteristicValue",
"value": {
"@type": "Equipment",
"serialNumber": "12444545544",
"versionNumber": "1.22",
"manufactureDate": "05-04-2017"
},


------------------------------
Pedan Andrey
TO BE VERIFIED

Original Message:
Sent: Dec 08, 2022 01:37
From: Pedan Andrey
Subject: TMF662 types characteristic

I got some answers here https://engage.tmforum.org/communities/community-home/digestviewer/viewthread?GroupId=31&MessageKey=06abec6e-393f-4729-9f9e-cf6cec91c8d5&CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5&tabReturn2%community%viewer -home%2fdigestviewer%3fcommunitykey%3dd543b8ba-9d3a-4121-85ce-5b68e6c31ce5%26tab%3ddigestviewer#bm06abec6e-393f-4729-9f9e-cf6cec91c8d5

But from the examples, it is not clear which approach to use:

1. With "valueType : object"
{
"name": "Equipment",
"valueType": "object",
"value": {
"@type": "Equipment",
"serialNumber": "12444545544",
"versionNumber": "1.22",
"manufactureDate": "05-04-2017"
},
"@schemaLocation": "http://serverlocation:port/partyManagement/schema/Equipment.yml"
}​

or

 "serviceCharacteristic": [
        {
            "name": "vCPE_IP",
            "valueType": "object",
            "value": {
                "@type": "IPAddress",
                "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/IPAddress.schema.json",
                "address": "193.218.236.21"
            }
        }

or

3. With "@type": "ObjectCharacteristicValue"
"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus",
"contactMedium": {
"emailAddress": "jean.pontus@orange.fr"
},
}
]

I need to describe such a model.
How to describe such a characteristic (the structure of objects is different)?:

"characteristic": [
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"giventName": "Jean",
"familyName" : "Pontus"
}
},
{
"name": "PartyIdentityData",
"id": "4df5-7tt",
"@type": "ObjectCharacteristicValue",
"value": {
"model": "BMW",
"number" : "525"
}
}

Both values are objects, how to describe them then with @type or valueType ObjectCharacteristicValue? Can there be such types as NameCharacteristicValue and autoCharacteristicValue?



------------------------------
Pedan Andrey
TO BE VERIFIED

Original Message:
Sent: Dec 07, 2022 07:19
From: Pedan Andrey
Subject: TMF662 types characteristic

Good afternoon.
We use the data model "Entity" to describe the specification and characteristics.
TMF662_Entity_Catalog_Management_API_User_Guide_v4.0.0.pdf
Can you please tell me how to specify the type of characteristic for the specification? Examples?
Characteristic values are different objects, how to describe this?
How, depending on the selected type of characteristic, to choose the desired structure of the value object?
All "value objects" have a different structure, depending on the type of characteristic.

In this example:

"specCharacteristic": [ { "name": "Platform", "id": "4441", "description": "This characteristic describes the platform of the node", "valueType": "string", "configurable": true, "validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "@valueSchemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/StringCharacteristic.schema.json", "minCardinality": 0, "maxCardinality": 1, "isUnique": true, "regex": "", "extensible": false,
"characteristicValueSpecification":
[ { "valueType": "string", "isDefault": true,
"value": "Windows",
"validFor": { "startDateTime": "2020-12-05T00:00", "endDateTime": "2023-12-31T11:59:59" }, "regex": "", "valueFrom": "", "valueTo": "", "unitOfMeasure": "", "rangeInterval": "open", "@type": "CharacteristicValueSpecification", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/CharacteristicValueSpecification.schema.json" } ], "charSpecRelationship": [], "@type": "SpecCharacteristic", "@baseType": "", "@schemaLocation": "https://mycsp.com:8080/tmf‐api/schema/Common/SpecCharacteristic.schema.json" } ],

Where to specify the "type of characteristic" ("specCharacteristic")? How to describe different "Value object", depending on the "characteristic type"? ValueType = object, what next? "object" have a different structure.

------------------------------
Pedan Andrey
TO BE VERIFIED
------------------------------