Create a set of entity attributes

post

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService

Request

Path Parameters
  • 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: publicSectorOpaEntities?q=EntityModelName=<value1>;EntityName=<value2>
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Use as Mapped in Attribute
    Maximum Length: 1
    Indicates if the entity attribute is mapped in as input attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped in.
  • Title: Use as Mapped Out Attribute
    Maximum Length: 1
    Indicates if the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped out.
  • Title: Data Type
    Maximum Length: 50
    The data type of the entity attribute.
  • Title: Default Value
    Maximum Length: 100
    The default value for the entity attribute.
  • Maximum Length: 1
    Default Value: N
    Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for an existing entity. The default value is N.
  • Title: Name
    Maximum Length: 40
    The name of the entity attribute.
  • Title: Name
    Maximum Length: 30
    The name of the entity model that is associated with the entity attribute.
  • Title: Name
    Maximum Length: 40
    The name of the entity that is associated with the entity attribute.
  • Title: Enumeration Attribute
    Maximum Length: 1
    Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.
  • Title: Primary Key
    Maximum Length: 1
    Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.
  • Maximum Length: 15
    The identifier of the notification that is associated with the entity attribute.
  • Title: Policy Modeling Data Type
    Maximum Length: 20
    The data type as shown in the policy modeler for the entity attribute.
  • Title: Enumeration Name
    Maximum Length: 30
    The name of the enumeration that is associated with the entity attribute.
  • Title: Hidden from Policy Modeling
    Maximum Length: 1
    Indicates if the entity attribute is hidden from policy modeling. Valid values are Y and N. If the value is Y, then it is a hidden attribute. The default value is N.
  • Title: Mandatory
    Maximum Length: 1
    Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y and N. If the value is Y, then it is a mandatory attribute.
  • Title: Policy Modeling Name
    Maximum Length: 100
    The name of the policy modeler for the entity attribute.
  • Maximum Length: 10
    The identifier of the owner associated with the entity attribute.
  • Default Value: 0
    Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : publicSectorOpaEntities-EntityAttributeService-item-response
Type: object
Show Source
  • Title: Use as Mapped in Attribute
    Maximum Length: 1
    Indicates if the entity attribute is mapped in as input attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped in.
  • Title: Use as Mapped Out Attribute
    Maximum Length: 1
    Indicates if the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped out.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The name of the user who created the entity attribute.
  • Title: Creation Date
    Read Only: true
    The date on which the entity attribute was created.
  • Title: Data Type
    Maximum Length: 50
    The data type of the entity attribute.
  • Title: Default Value
    Maximum Length: 100
    The default value for the entity attribute.
  • Maximum Length: 1
    Default Value: N
    Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for an existing entity. The default value is N.
  • Title: Name
    Maximum Length: 40
    The name of the entity attribute.
  • Title: Name
    Maximum Length: 30
    The name of the entity model that is associated with the entity attribute.
  • Title: Name
    Maximum Length: 40
    The name of the entity that is associated with the entity attribute.
  • Title: Enumeration Attribute
    Maximum Length: 1
    Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.
  • Title: Primary Key
    Maximum Length: 1
    Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.
  • Title: Last Updated Date
    Read Only: true
    The date on which the entity attribute was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The name of the user who last updated the entity attribute.
  • Links
  • Maximum Length: 15
    The identifier of the notification that is associated with the entity attribute.
  • Title: Policy Modeling Data Type
    Maximum Length: 20
    The data type as shown in the policy modeler for the entity attribute.
  • Title: Enumeration Name
    Maximum Length: 30
    The name of the enumeration that is associated with the entity attribute.
  • Title: Hidden from Policy Modeling
    Maximum Length: 1
    Indicates if the entity attribute is hidden from policy modeling. Valid values are Y and N. If the value is Y, then it is a hidden attribute. The default value is N.
  • Title: Mandatory
    Maximum Length: 1
    Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y and N. If the value is Y, then it is a mandatory attribute.
  • Title: Policy Modeling Name
    Maximum Length: 100
    The name of the policy modeler for the entity attribute.
  • Maximum Length: 10
    The identifier of the owner associated with the entity attribute.
  • Default Value: 0
    Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
Back to Top