Jump to

• Request
• Response

Create a derivation rule

post

/fscmRestApi/resources/11.13.18.05/attributeDerivationRules

Request

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.
• Upsert-Mode: string
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeCategory: string
  Category of the target attribute associated with the derivation rule.
• Condition: string
  Condition assigned to the derivation rule to determine when to apply the rule.
• Entity: string
  Maximum Length: 255

  Entity assigned to the attribute derivation rule.
• EntityClass: string
  Maximum Length: 255

  Entity class assigned to the attribute derivation rule.
• EntityType: string
  Maximum Length: 255

  Entity type assigned to the attribute derivation rule.
• LevelCode: string
  Maximum Length: 255

  Level assigned to the attribute derivation rule.
• MappingSetCode: string
  Maximum Length: 255

  Mapping set assigned to the attribute derivation rule.
• Priority: integer
  Priority in which derivation rules are applied to derive the target attribute.
• RuleType: string
  Type of attribute derivation rule, such as Copy From and Mapping Set.
• SourceAttribute: string
  Column name of the source attribute.
• SourceAttributeCode: string
  Maximum Length: 255

  Source attribute name.
• SourceTableName: string
  Maximum Length: 255

  Table name of the source attribute.
• StatusCode: string
  Maximum Length: 255

  Status code of the rule.
• TargetAttribute: string
  Maximum Length: 255

  Target attribute name.

{
    "type":"object",
    "properties":{
        "Condition":{
            "type":"string",
            "description":"Condition assigned to the derivation rule to determine when to apply the rule.",
            "nullable":true
        },
        "SourceTableName":{
            "maxLength":255,
            "type":"string",
            "description":"Table name of the source attribute.",
            "nullable":true
        },
        "Entity":{
            "maxLength":255,
            "type":"string",
            "description":"Entity assigned to the attribute derivation rule.",
            "nullable":true
        },
        "MappingSetCode":{
            "maxLength":255,
            "type":"string",
            "description":"Mapping set assigned to the attribute derivation rule.",
            "nullable":true
        },
        "LevelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Level assigned to the attribute derivation rule.",
            "nullable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority in which derivation rules are applied to derive the target attribute.",
            "nullable":true
        },
        "SourceAttributeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Source attribute name.",
            "nullable":true
        },
        "AttributeCategory":{
            "type":"string",
            "description":"Category of the target attribute associated with the derivation rule.",
            "nullable":true
        },
        "RuleType":{
            "type":"string",
            "description":"Type of attribute derivation rule, such as Copy From and Mapping Set.",
            "nullable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Status code of the rule.",
            "nullable":true
        },
        "EntityType":{
            "maxLength":255,
            "type":"string",
            "description":"Entity type assigned to the attribute derivation rule.",
            "nullable":true
        },
        "SourceAttribute":{
            "type":"string",
            "description":"Column name of the source attribute.",
            "nullable":true
        },
        "EntityClass":{
            "maxLength":255,
            "type":"string",
            "description":"Entity class assigned to the attribute derivation rule.",
            "nullable":true
        },
        "TargetAttribute":{
            "maxLength":255,
            "type":"string",
            "description":"Target attribute name.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : attributeDerivationRules-item-response

Type: object

Show Source

• AttributeCategory: string
  Category of the target attribute associated with the derivation rule.
• AttributeRuleId: integer
  Read Only: true

  The unique identifier of the rule.
• Condition: string
  Condition assigned to the derivation rule to determine when to apply the rule.
• Entity: string
  Maximum Length: 255

  Entity assigned to the attribute derivation rule.
• EntityClass: string
  Maximum Length: 255

  Entity class assigned to the attribute derivation rule.
• EntityType: string
  Maximum Length: 255

  Entity type assigned to the attribute derivation rule.
• LevelCode: string
  Maximum Length: 255

  Level assigned to the attribute derivation rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingSetCode: string
  Maximum Length: 255

  Mapping set assigned to the attribute derivation rule.
• Priority: integer
  Priority in which derivation rules are applied to derive the target attribute.
• RuleType: string
  Type of attribute derivation rule, such as Copy From and Mapping Set.
• SourceAttribute: string
  Column name of the source attribute.
• SourceAttributeCode: string
  Maximum Length: 255

  Source attribute name.
• SourceTableName: string
  Maximum Length: 255

  Table name of the source attribute.
• StatusCode: string
  Maximum Length: 255

  Status code of the rule.
• TargetAttribute: string
  Maximum Length: 255

  Target attribute name.

{
    "type":"object",
    "properties":{
        "Condition":{
            "type":"string",
            "description":"Condition assigned to the derivation rule to determine when to apply the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTableName":{
            "maxLength":255,
            "type":"string",
            "description":"Table name of the source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "maxLength":255,
            "type":"string",
            "description":"Entity assigned to the attribute derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingSetCode":{
            "maxLength":255,
            "type":"string",
            "description":"Mapping set assigned to the attribute derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "LevelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Level assigned to the attribute derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority in which derivation rules are applied to derive the target attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAttributeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Source attribute name.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCategory":{
            "type":"string",
            "description":"Category of the target attribute associated with the derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleType":{
            "type":"string",
            "description":"Type of attribute derivation rule, such as Copy From and Mapping Set.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Status code of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityType":{
            "maxLength":255,
            "type":"string",
            "description":"Entity type assigned to the attribute derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAttribute":{
            "type":"string",
            "description":"Column name of the source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityClass":{
            "maxLength":255,
            "type":"string",
            "description":"Entity class assigned to the attribute derivation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeRuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetAttribute":{
            "maxLength":255,
            "type":"string",
            "description":"Target attribute name.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top