Open APIs

 View Only
  • 1.  Additional attributes or objects for open api

    Posted Sep 20, 2017 12:22
    Hello,
    I need to have rest api for maintenance activity on devices. Currently I don't find any api which matches with Maintenance Events, it can be a sub part of change request but that is at a very high level. 
    My questions:
    1. Is it okay to add additional fields/attributes in the existing resource model? For e.g. RelatedPartyRef has limited attributes whereas I need more attributes.
    2. Characteristic class model seems to be ideal fit but it makes my design very complex as I have more that 20 custom fields/attributes.
    3. TargetEntity model does not provide complete details about resource/device on which change request will be happening? How can I add extra information. Below is standard model.

    TargetEntityRef fields

    The entity which will be changed or configured while the change request is executed.

    description

    A String. The description to the related party.

    href

    A String. Hyperlink to access the target entity.

    id

    A String. Identifier of target entity



    Thanks for reading till end :). Looking forward for valuable comments.



    ------------------------------
    Vishal Srivastava
    SOPRA STERIA GROUP INDIA
    ------------------------------


  • 2.  RE: Additional attributes or objects for open api

    Posted Sep 22, 2017 04:04
    Is it okay to add additional fields/attributes in the existing resource model? For e.g. RelatedPartyRef has limited attributes whereas I need more attributes.
    Vishal Srivastava,  09-20-2017 12:21
    I would say yes. If you need more attributes that apply to all your resources, you can add them in the model. SID cannot discover all attributes that everyone needs.
    Characteristic class model seems to be ideal fit but it makes my design very complex as I have more that 20 custom fields/attributes.
    Vishal Srivastava,  09-20-2017 12:21
    Indeed, the CharacteristicSpecification pattern is ideal in theory but not in practice-unless you have a tool with a solid implementation of this pattern that makes it easy to use. Meanwhile, you can use explicit modeling: no characteristic pattern, just a simple class diagram with attributes, inheritance and composition. For complex characteristics, you have to use separate classes.