Jump to

• Request
• Response

Update an entity

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• EntityModelName: string
  The name of the entity model.
• EntityServiceUniqID: integer
  This is the hash key of the attributes which make up the composite key--- EntityModelName and EntityName ---for the Entities resource and used to uniquely identify an instance of Entities. The client should not generate the hash key value. Instead, the client should query on the Entities collection resource with a filter on the primary key values in order to navigate to a specific instance of Entities.
  
  For example: EntityService?q=EntityModelName=<value1>;EntityName=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorOpaEntityModels-EntityService-item

Type: object

Show Source

• BelongsToTechstack(optional): string
  Maximum Length: 1

  Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N.
• CanBeInput(optional): string
  Title: Use as Mapped in Entity

  Maximum Length: 1

  Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Entity

  Maximum Length: 1

  Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.
• CardinalityWithParent(optional): string
  Title: Cardinality with Parent Entity

  Maximum Length: 5

  Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of user who created the entity.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the entity was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId(optional): number
  The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model that is associated with the entity.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity.
• IsTopLevel(optional): string
  Title: Top-Level Entity

  Maximum Length: 1

  Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the entity was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the entity.
• links(optional): array Items
  Title: Items

  Link Relations
• NotificationId(optional): string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity.
• OpaHidden(optional): string
  Title: Hidden from Policy Modeling

  Maximum Length: 1

  Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N.
• OpaLinkName(optional): string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The type if relationship between the entity and its parent entity in the associated entity model.
• OpaName(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name as displayed in the Policy Modeler for the entity.
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity.
• ParentEoName(optional): string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock(optional): integer(int32)
  Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• SupportsAttachment(optional): string
  Title: Supports Attachment

  Maximum Length: 1

  Indicates if the entity supports a collection of attachments. Valid values are Y or N.
• SupportsDynamicLoad(optional): string
  Title: Supports Dynamic Default Values

  Maximum Length: 1

  Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.
• ViewObjectId(optional): integer(int64)
  Title: View Object ID

  The identifier of the View object that is associated with the entity.

{
    "properties":{
        "BelongsToTechstack":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N."
        },
        "CanBeInput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped in Entity"
        },
        "CanBeOutput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped Out Entity"
        },
        "CardinalityWithParent":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.",
            "title":"Cardinality with Parent Entity"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of user who created the entity.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the entity.",
            "title":"Description"
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The Identifier of the View object associated with the entity from which the default values will be dynamically loaded."
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "title":"Name"
        },
        "EntityName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the entity.",
            "title":"Name"
        },
        "IsTopLevel":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N.",
            "title":"Top-Level Entity"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity.",
            "title":"Last Updated By"
        },
        "NotificationId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity."
        },
        "OpaHidden":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N.",
            "title":"Hidden from Policy Modeling"
        },
        "OpaLinkName":{
            "maxLength":100,
            "type":"string",
            "description":"The type if relationship between the entity and its parent entity in the associated entity model.",
            "title":"Policy Modeling Relationship Name"
        },
        "OpaName":{
            "maxLength":100,
            "type":"string",
            "description":"The name as displayed in the Policy Modeler for the entity.",
            "title":"Policy Modeling Name"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity."
        },
        "ParentEoName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "title":"Parent Entity Name"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified."
        },
        "SupportsAttachment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports a collection of attachments. Valid values are Y or N.",
            "title":"Supports Attachment"
        },
        "SupportsDynamicLoad":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.",
            "title":"Supports Dynamic Default Values"
        },
        "ViewObjectId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "title":"View Object ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaEntityModels-EntityService-item

Type: object

Show Source

• BelongsToTechstack(optional): string
  Maximum Length: 1

  Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N.
• CanBeInput(optional): string
  Title: Use as Mapped in Entity

  Maximum Length: 1

  Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Entity

  Maximum Length: 1

  Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.
• CardinalityWithParent(optional): string
  Title: Cardinality with Parent Entity

  Maximum Length: 5

  Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of user who created the entity.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the entity was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId(optional): number
  The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model that is associated with the entity.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity.
• IsTopLevel(optional): string
  Title: Top-Level Entity

  Maximum Length: 1

  Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the entity was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the entity.
• links(optional): array Items
  Title: Items

  Link Relations
• NotificationId(optional): string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity.
• OpaHidden(optional): string
  Title: Hidden from Policy Modeling

  Maximum Length: 1

  Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N.
• OpaLinkName(optional): string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The type if relationship between the entity and its parent entity in the associated entity model.
• OpaName(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name as displayed in the Policy Modeler for the entity.
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity.
• ParentEoName(optional): string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock(optional): integer(int32)
  Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• SupportsAttachment(optional): string
  Title: Supports Attachment

  Maximum Length: 1

  Indicates if the entity supports a collection of attachments. Valid values are Y or N.
• SupportsDynamicLoad(optional): string
  Title: Supports Dynamic Default Values

  Maximum Length: 1

  Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.
• ViewObjectId(optional): integer(int64)
  Title: View Object ID

  The identifier of the View object that is associated with the entity.

{
    "properties":{
        "BelongsToTechstack":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N."
        },
        "CanBeInput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped in Entity"
        },
        "CanBeOutput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped Out Entity"
        },
        "CardinalityWithParent":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.",
            "title":"Cardinality with Parent Entity"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of user who created the entity.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the entity.",
            "title":"Description"
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The Identifier of the View object associated with the entity from which the default values will be dynamically loaded."
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "title":"Name"
        },
        "EntityName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the entity.",
            "title":"Name"
        },
        "IsTopLevel":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N.",
            "title":"Top-Level Entity"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity.",
            "title":"Last Updated By"
        },
        "NotificationId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity."
        },
        "OpaHidden":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N.",
            "title":"Hidden from Policy Modeling"
        },
        "OpaLinkName":{
            "maxLength":100,
            "type":"string",
            "description":"The type if relationship between the entity and its parent entity in the associated entity model.",
            "title":"Policy Modeling Relationship Name"
        },
        "OpaName":{
            "maxLength":100,
            "type":"string",
            "description":"The name as displayed in the Policy Modeler for the entity.",
            "title":"Policy Modeling Name"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity."
        },
        "ParentEoName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "title":"Parent Entity Name"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified."
        },
        "SupportsAttachment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports a collection of attachments. Valid values are Y or N.",
            "title":"Supports Attachment"
        },
        "SupportsDynamicLoad":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.",
            "title":"Supports Dynamic Default Values"
        },
        "ViewObjectId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "title":"View Object ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top