Jump to

• Request
• Response

Update a value set

patch

/fscmRestApi/resources/11.13.18.05/attributeDerivationMappingSets/{MappingSetId}/child/FunAdmMappingSetFlavor/{MappingSetFlavorId}

Request

Path Parameters

• MappingSetFlavorId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• MappingSetId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DefaultCcid: integer (int64)
  Default output value associated with a mapping set.
• DefaultConstant: string
  Maximum Length: 240

  Default output value associated with a mapping set.
• FunAdmMappingSetValues: array Mappings
  Title: Mappings

  Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.
• MappingSetCode(required): string
  Maximum Length: 30

  Short name of mapping set.
• MappingSetFlavorId: integer (int64)
  The unique identifier of the value set assignment.
• StripeId(required): integer (int64)
  The unique identifier of the input source value set.

{
    "required":[
        "MappingSetCode",
        "StripeId"
    ],
    "type":"object",
    "properties":{
        "StripeId":{
            "type":"integer",
            "description":"The unique identifier of the input source value set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MappingSetCode":{
            "maxLength":30,
            "type":"string",
            "description":"Short name of mapping set.",
            "nullable":false
        },
        "DefaultCcid":{
            "type":"integer",
            "description":"Default output value associated with a mapping set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MappingSetFlavorId":{
            "type":"integer",
            "description":"The unique identifier of the value set assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DefaultConstant":{
            "maxLength":240,
            "type":"string",
            "description":"Default output value associated with a mapping set.",
            "nullable":true
        },
        "FunAdmMappingSetValues":{
            "title":"Mappings",
            "type":"array",
            "description":"Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.",
            "items":{
                "$ref":"#/components/schemas/attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-patch-request"
            }
        }
    }
}

Nested Schema : Mappings

Type: array

Title: Mappings

Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.

Show Source

• Array of: object attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-patch-request

{
    "title":"Mappings",
    "type":"array",
    "description":"Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.",
    "items":{
        "$ref":"#/components/schemas/attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-patch-request"
    }
}

Nested Schema : attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-patch-request

Type: object

Show Source

• EffectiveEndDate: string (date)
  Effective end date of the mapping.
• EffectiveStartDate: string (date)
  Effective start date of the mapping.
• Enabled: string
  Maximum Length: 1

  Default Value: Y

  Indicates whether the mapping is enabled.
• InputValueConstant1: string
  Maximum Length: 240

  The value of the first input source.
• InputValueConstant10: string
  Maximum Length: 30

  The value of the tenth input source.
• InputValueConstant2: string
  Maximum Length: 240

  The value of the second input source.
• InputValueConstant3: string
  Maximum Length: 240

  The value of the third input source.
• InputValueConstant4: string
  Maximum Length: 30

  The value of the fourth input source.
• InputValueConstant5: string
  Maximum Length: 30

  The value of the fifth input source.
• InputValueConstant6: string
  Maximum Length: 30

  The value of the sixth input source.
• InputValueConstant7: string
  Maximum Length: 30

  The value of the seventh input source.
• InputValueConstant8: string
  Maximum Length: 30

  The value of the eighth input source.
• InputValueConstant9: string
  Maximum Length: 30

  The value of the ninth input source.
• MappingSetFlavorId: integer (int64)
  The unique identifier of the value set assignment.
• TransactionCOAId: integer (int64)
  The unique identifier of the chart of account associated with the input source.
• ValueCodeCombinationId: integer (int64)
  Code combination identifier associated with the output.
• ValueConstant: string
  Maximum Length: 240

  Output value associated with a mapping when no default output is specified.

{
    "type":"object",
    "properties":{
        "InputValueConstant10":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the tenth input source.",
            "nullable":true
        },
        "InputValueConstant6":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the sixth input source.",
            "nullable":true
        },
        "InputValueConstant5":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the fifth input source.",
            "nullable":true
        },
        "InputValueConstant4":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the fourth input source.",
            "nullable":true
        },
        "InputValueConstant3":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the third input source.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the mapping.",
            "format":"date",
            "nullable":false
        },
        "InputValueConstant9":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the ninth input source.",
            "nullable":true
        },
        "InputValueConstant8":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the eighth input source.",
            "nullable":true
        },
        "InputValueConstant7":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the seventh input source.",
            "nullable":true
        },
        "ValueCodeCombinationId":{
            "type":"integer",
            "description":"Code combination identifier associated with the output.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the mapping is enabled.",
            "nullable":false,
            "default":"Y"
        },
        "InputValueConstant2":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the second input source.",
            "nullable":true
        },
        "InputValueConstant1":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the first input source.",
            "nullable":true
        },
        "TransactionCOAId":{
            "type":"integer",
            "description":"The unique identifier of the chart of account associated with the input source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MappingSetFlavorId":{
            "type":"integer",
            "description":"The unique identifier of the value set assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ValueConstant":{
            "maxLength":240,
            "type":"string",
            "description":"Output value associated with a mapping when no default output is specified.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the mapping.",
            "format":"date",
            "nullable":false
        }
    }
}

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 : attributeDerivationMappingSets-FunAdmMappingSetFlavor-item-response

Type: object

Show Source

• DefaultCcid: integer (int64)
  Default output value associated with a mapping set.
• DefaultConstant: string
  Maximum Length: 240

  Default output value associated with a mapping set.
• FunAdmMappingSetValues: array Mappings
  Title: Mappings

  Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.
• links: array Links
  Title: Links

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

  Short name of mapping set.
• MappingSetFlavorId: integer (int64)
  The unique identifier of the value set assignment.
• StripeId: integer (int64)
  The unique identifier of the input source value set.
• ValueSetCode: string
  Read Only: true

  Maximum Length: 255

  Value set associated with the mapping set input source.

{
    "type":"object",
    "properties":{
        "StripeId":{
            "type":"integer",
            "description":"The unique identifier of the input source value set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValueSetCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value set associated with the mapping set input source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingSetCode":{
            "maxLength":30,
            "type":"string",
            "description":"Short name of mapping set.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingSetFlavorId":{
            "type":"integer",
            "description":"The unique identifier of the value set assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultConstant":{
            "maxLength":240,
            "type":"string",
            "description":"Default output value associated with a mapping set.",
            "nullable":true,
            "x-queryable":true
        },
        "FunAdmMappingSetValues":{
            "title":"Mappings",
            "type":"array",
            "description":"Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.",
            "items":{
                "$ref":"#/components/schemas/attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultCcid":{
            "type":"integer",
            "description":"Default output value associated with a mapping set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Mappings

Type: array

Title: Mappings

Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.

Show Source

• Array of: object attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response

{
    "title":"Mappings",
    "type":"array",
    "description":"Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.",
    "items":{
        "$ref":"#/components/schemas/attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response"
    }
}

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 : attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response

Type: object

Show Source

• EffectiveEndDate: string (date)
  Effective end date of the mapping.
• EffectiveStartDate: string (date)
  Effective start date of the mapping.
• Enabled: string
  Maximum Length: 1

  Default Value: Y

  Indicates whether the mapping is enabled.
• InputValueConstant1: string
  Maximum Length: 240

  The value of the first input source.
• InputValueConstant10: string
  Maximum Length: 30

  The value of the tenth input source.
• InputValueConstant2: string
  Maximum Length: 240

  The value of the second input source.
• InputValueConstant3: string
  Maximum Length: 240

  The value of the third input source.
• InputValueConstant4: string
  Maximum Length: 30

  The value of the fourth input source.
• InputValueConstant5: string
  Maximum Length: 30

  The value of the fifth input source.
• InputValueConstant6: string
  Maximum Length: 30

  The value of the sixth input source.
• InputValueConstant7: string
  Maximum Length: 30

  The value of the seventh input source.
• InputValueConstant8: string
  Maximum Length: 30

  The value of the eighth input source.
• InputValueConstant9: string
  Maximum Length: 30

  The value of the ninth input source.
• links: array Links
  Title: Links

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

  Short name of mapping set.
• MappingSetFlavorId: integer (int64)
  The unique identifier of the value set assignment.
• MappingSetValueId: integer (int64)
  The unique identifier of the mapping.
• StripeId: integer (int64)
  The unique identifier of the input source value set.
• TransactionCOAId: integer (int64)
  The unique identifier of the chart of account associated with the input source.
• ValueCodeCombinationId: integer (int64)
  Code combination identifier associated with the output.
• ValueConstant: string
  Maximum Length: 240

  Output value associated with a mapping when no default output is specified.

{
    "type":"object",
    "properties":{
        "MappingSetValueId":{
            "type":"integer",
            "description":"The unique identifier of the mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InputValueConstant10":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the tenth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant6":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the sixth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant5":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the fifth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingSetCode":{
            "maxLength":30,
            "type":"string",
            "description":"Short name of mapping set.",
            "nullable":false,
            "x-queryable":true
        },
        "InputValueConstant4":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the fourth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant3":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the third input source.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the mapping.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InputValueConstant9":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the ninth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant8":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the eighth input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant7":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the seventh input source.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueCodeCombinationId":{
            "type":"integer",
            "description":"Code combination identifier associated with the output.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the mapping is enabled.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "InputValueConstant2":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the second input source.",
            "nullable":true,
            "x-queryable":true
        },
        "InputValueConstant1":{
            "maxLength":240,
            "type":"string",
            "description":"The value of the first input source.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCOAId":{
            "type":"integer",
            "description":"The unique identifier of the chart of account associated with the input source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StripeId":{
            "type":"integer",
            "description":"The unique identifier of the input source value set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MappingSetFlavorId":{
            "type":"integer",
            "description":"The unique identifier of the value set assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValueConstant":{
            "maxLength":240,
            "type":"string",
            "description":"Output value associated with a mapping when no default output is specified.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the mapping.",
            "format":"date",
            "nullable":false,
            "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."
        }
    }
}

Links

FunAdmMappingSetValues

Operation: /fscmRestApi/resources/11.13.18.05/attributeDerivationMappingSets/{MappingSetId}/child/FunAdmMappingSetFlavor/{MappingSetFlavorId}/child/FunAdmMappingSetValues

Parameters:

• MappingSetFlavorId: $request.path.MappingSetFlavorId
• MappingSetId: $request.path.MappingSetId

Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.

Back to Top