Jump to

• Request
• Response

Create one transformation flow definition

post

/fscmRestApi/resources/11.13.18.05/transformationFlows

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

• FlowCode(required): string
  Maximum Length: 80

  Code that identifies the transformation flow definition.
• FlowName(required): string
  Maximum Length: 240

  Name of the transformation flow definition.
• transformFlow: array Transform Flows
  Title: Transform Flows

  A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.

{
    "required":[
        "FlowCode",
        "FlowName"
    ],
    "type":"object",
    "properties":{
        "FlowCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code that identifies the transformation flow definition.",
            "nullable":false
        },
        "FlowName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the transformation flow definition.",
            "nullable":false
        },
        "transformFlow":{
            "title":"Transform Flows",
            "type":"array",
            "description":"A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.",
            "items":{
                "$ref":"#/components/schemas/transformationFlows-transformFlow-item-post-request"
            }
        }
    }
}

Nested Schema : Transform Flows

Type: array

Title: Transform Flows

A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.

Show Source

• Array of: object transformationFlows-transformFlow-item-post-request

{
    "title":"Transform Flows",
    "type":"array",
    "description":"A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.",
    "items":{
        "$ref":"#/components/schemas/transformationFlows-transformFlow-item-post-request"
    }
}

Nested Schema : transformationFlows-transformFlow-item-post-request

Type: object

Show Source

• ActiveFlag(required): boolean
  Maximum Length: 1

  Indicates whether the transformation flow is active. Contains one of these values: true or false. If true, then the transformation flow is active. If false, then the transformation flow isn't active. This attribute doesn't have a default value.
• DocumentName: string
  Name of the document for which the transformation flow is set up.
• ExternalMessageTypeId: integer
  Name of the message.
• ExternalMessageTypeName: string
  Name of the message.
• MappingFile: string (byte)
  File that contains the mapping definition for the transformation flow.
• MappingFileName: string
  Name of the mapping file.
• MappingFunctionsFile: string (byte)
  File that contains the mapping functions for the transformation flow.
• MappingFunctionsFilename: string
  Name of the file that contains the mapping functions.
• MessageId(required): integer (int64)
  Unique identifier of the message.
• MessageName: string
  Name of the message.
• ModifiedBy: string
  Maximum Length: 64

  User who last updated the record.
• ModifiedOn: string (date-time)
  Date when the record was last updated.
• ParentFlowId: integer (int64)
  Unique identifier of the parent transformation flow.
• TransformMode: string
  Mode that determines how the transformation flow processes the data.
• VariantNumber: integer (int32)
  Default Value: 0

  Number of the transform flow variant.
• variants: array Variants
  Title: Variants

  An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.
• VersionNumber: integer (int32)
  Default Value: 1

  Number for the version of the transform flow variant.
• XformFlowDefId(required): integer (int64)
  Unique identifier of the transformation flow definition.

{
    "required":[
        "ActiveFlag",
        "MessageId",
        "XformFlowDefId"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transformation flow is active. Contains one of these values: true or false. If true, then the transformation flow is active. If false, then the transformation flow isn't active. This attribute doesn't have a default value.",
            "nullable":false
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the document for which the transformation flow is set up.",
            "nullable":true
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Name of the message.",
            "nullable":true
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true
        },
        "MappingFile":{
            "type":"string",
            "description":"File that contains the mapping definition for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFileName":{
            "type":"string",
            "description":"Name of the mapping file.",
            "nullable":true
        },
        "MappingFunctionsFile":{
            "type":"string",
            "description":"File that contains the mapping functions for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFunctionsFilename":{
            "type":"string",
            "description":"Name of the file that contains the mapping functions.",
            "nullable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true
        },
        "ModifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false
        },
        "ModifiedOn":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false
        },
        "ParentFlowId":{
            "type":"integer",
            "description":"Unique identifier of the parent transformation flow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransformMode":{
            "type":"string",
            "description":"Mode that determines how the transformation flow processes the data.",
            "nullable":true
        },
        "VariantNumber":{
            "type":"integer",
            "description":"Number of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "VersionNumber":{
            "type":"integer",
            "description":"Number for the version of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            }
        },
        "XformFlowDefId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "variants":{
            "title":"Variants",
            "type":"array",
            "description":"An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.",
            "items":{
                "$ref":"#/components/schemas/transformationFlows-transformFlow-variants-item-post-request"
            }
        }
    }
}

Nested Schema : Variants

Type: array

Title: Variants

An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.

Show Source

• Array of: object transformationFlows-transformFlow-variants-item-post-request

{
    "title":"Variants",
    "type":"array",
    "description":"An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.",
    "items":{
        "$ref":"#/components/schemas/transformationFlows-transformFlow-variants-item-post-request"
    }
}

Nested Schema : transformationFlows-transformFlow-variants-item-post-request

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the variant is active. Contains one of these values: true or false. If true, then the variant is active. If false, then the variant isn't active. This attribute doesn't have a default value.
• DocumentName: string
  Name of the document for which the transformation flow is set up.
• ExternalMessageTypeId: integer
  Name of the message.
• ExternalMessageTypeName: string
  Name of the message.
• MappingFile: string (byte)
  File that contains the mapping definition for the transformation flow.
• MappingFileName: string
  Name of the mapping file.
• MappingFunctionsFile: string (byte)
  File that contains the mapping functions for the transformation flow.
• MappingFunctionsFilename: string
  Name of the file that contains the mapping functions.
• MessageId: integer (int64)
  Unique identifier of the message.
• MessageName: string
  Name of the message.
• ModifiedBy: string
  Maximum Length: 64

  User who last updated the record.
• ModifiedOn: string (date-time)
  Date when the record was last updated.
• ParentFlowId: integer (int64)
  Unique identifier of the parent transformation flow.
• TransformMode: string
  Mode that determines how the transformation flow processes the data.
• VariantNumber: integer (int32)
  Default Value: 0

  Number of the transform flow variant.
• VersionNumber: integer (int32)
  Default Value: 1

  Number for the version of the transform flow variant.
• XformFlowDefId: integer (int64)
  Unique identifier of the transformation flow definition.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the variant is active. Contains one of these values: true or false. If true, then the variant is active. If false, then the variant isn't active. This attribute doesn't have a default value.",
            "nullable":false
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the document for which the transformation flow is set up.",
            "nullable":true
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Name of the message.",
            "nullable":true
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true
        },
        "MappingFile":{
            "type":"string",
            "description":"File that contains the mapping definition for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFileName":{
            "type":"string",
            "description":"Name of the mapping file.",
            "nullable":true
        },
        "MappingFunctionsFile":{
            "type":"string",
            "description":"File that contains the mapping functions for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFunctionsFilename":{
            "type":"string",
            "description":"Name of the file that contains the mapping functions.",
            "nullable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true
        },
        "ModifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false
        },
        "ModifiedOn":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false
        },
        "ParentFlowId":{
            "type":"integer",
            "description":"Unique identifier of the parent transformation flow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransformMode":{
            "type":"string",
            "description":"Mode that determines how the transformation flow processes the data.",
            "nullable":true
        },
        "VariantNumber":{
            "type":"integer",
            "description":"Number of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "VersionNumber":{
            "type":"integer",
            "description":"Number for the version of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            }
        },
        "XformFlowDefId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : transformationFlows-item-response

Type: object

Show Source

• FlowCode: string
  Maximum Length: 80

  Code that identifies the transformation flow definition.
• FlowName: string
  Maximum Length: 240

  Name of the transformation flow definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• transformFlow: array Transform Flows
  Title: Transform Flows

  A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.
• XformFlowDefId: integer (int64)
  Read Only: true

  Unique identifier of the transformation flow definition.

{
    "type":"object",
    "properties":{
        "FlowCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code that identifies the transformation flow definition.",
            "nullable":false,
            "x-queryable":true
        },
        "FlowName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the transformation flow definition.",
            "nullable":false,
            "x-queryable":true
        },
        "XformFlowDefId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "transformFlow":{
            "title":"Transform Flows",
            "type":"array",
            "description":"A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.",
            "items":{
                "$ref":"#/components/schemas/transformationFlows-transformFlow-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 : Transform Flows

Type: array

Title: Transform Flows

A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.

Show Source

• Array of: object transformationFlows-transformFlow-item-response

{
    "title":"Transform Flows",
    "type":"array",
    "description":"A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.",
    "items":{
        "$ref":"#/components/schemas/transformationFlows-transformFlow-item-response"
    }
}

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."
        }
    }
}

Nested Schema : transformationFlows-transformFlow-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the transformation flow is active. Contains one of these values: true or false. If true, then the transformation flow is active. If false, then the transformation flow isn't active. This attribute doesn't have a default value.
• DocumentName: string
  Name of the document for which the transformation flow is set up.
• ExternalMessageTypeId: integer
  Name of the message.
• ExternalMessageTypeName: string
  Name of the message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingFile: string (byte)
  File that contains the mapping definition for the transformation flow.
• MappingFileName: string
  Name of the mapping file.
• MappingFunctionsFile: string (byte)
  File that contains the mapping functions for the transformation flow.
• MappingFunctionsFilename: string
  Name of the file that contains the mapping functions.
• MessageId: integer (int64)
  Unique identifier of the message.
• MessageName: string
  Name of the message.
• ModifiedBy: string
  Maximum Length: 64

  User who last updated the record.
• ModifiedOn: string (date-time)
  Date when the record was last updated.
• ParentFlowId: integer (int64)
  Unique identifier of the parent transformation flow.
• Status: string
  Read Only: true

  Maximum Length: 30

  Status of the transform flow.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the transform flow status.
• TransformMode: string
  Mode that determines how the transformation flow processes the data.
• UserDefinedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the transform flow is user-defined.
• VariantNumber: integer (int32)
  Default Value: 0

  Number of the transform flow variant.
• variants: array Variants
  Title: Variants

  An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.
• VersionLabel: string
  Read Only: true

  Maximum Length: 30

  Label for the version of the transform flow variant.
• VersionNumber: integer (int32)
  Default Value: 1

  Number for the version of the transform flow variant.
• XformFlowDefId: integer (int64)
  Unique identifier of the transformation flow definition.
• XformFlowId: integer (int64)
  Read Only: true

  Unique identifier of the transformation flow.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transformation flow is active. Contains one of these values: true or false. If true, then the transformation flow is active. If false, then the transformation flow isn't active. This attribute doesn't have a default value.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the document for which the transformation flow is set up.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingFile":{
            "type":"string",
            "description":"File that contains the mapping definition for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFileName":{
            "type":"string",
            "description":"Name of the mapping file.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingFunctionsFile":{
            "type":"string",
            "description":"File that contains the mapping functions for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFunctionsFilename":{
            "type":"string",
            "description":"Name of the file that contains the mapping functions.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ModifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ModifiedOn":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ParentFlowId":{
            "type":"integer",
            "description":"Unique identifier of the parent transformation flow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the transform flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the transform flow status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformMode":{
            "type":"string",
            "description":"Mode that determines how the transformation flow processes the data.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transform flow is user-defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VariantNumber":{
            "type":"integer",
            "description":"Number of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "VersionLabel":{
            "maxLength":30,
            "type":"string",
            "description":"Label for the version of the transform flow variant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "type":"integer",
            "description":"Number for the version of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "XformFlowDefId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "XformFlowId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "variants":{
            "title":"Variants",
            "type":"array",
            "description":"An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.",
            "items":{
                "$ref":"#/components/schemas/transformationFlows-transformFlow-variants-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 : Variants

Type: array

Title: Variants

An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.

Show Source

• Array of: object transformationFlows-transformFlow-variants-item-response

{
    "title":"Variants",
    "type":"array",
    "description":"An implementation of a Transform Flow version. A Variant inherits the configuration of its parent Transform Flow while allowing modifications to the transformation and mapping logic.",
    "items":{
        "$ref":"#/components/schemas/transformationFlows-transformFlow-variants-item-response"
    }
}

Nested Schema : transformationFlows-transformFlow-variants-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the variant is active. Contains one of these values: true or false. If true, then the variant is active. If false, then the variant isn't active. This attribute doesn't have a default value.
• DocumentName: string
  Name of the document for which the transformation flow is set up.
• ExternalMessageTypeId: integer
  Name of the message.
• ExternalMessageTypeName: string
  Name of the message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingFile: string (byte)
  File that contains the mapping definition for the transformation flow.
• MappingFileName: string
  Name of the mapping file.
• MappingFunctionsFile: string (byte)
  File that contains the mapping functions for the transformation flow.
• MappingFunctionsFilename: string
  Name of the file that contains the mapping functions.
• MessageId: integer (int64)
  Unique identifier of the message.
• MessageName: string
  Name of the message.
• ModifiedBy: string
  Maximum Length: 64

  User who last updated the record.
• ModifiedOn: string (date-time)
  Date when the record was last updated.
• ParentFlowId: integer (int64)
  Unique identifier of the parent transformation flow.
• Status: string
  Read Only: true

  Maximum Length: 30

  Status of the transform flow.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the transform flow status.
• TransformMode: string
  Mode that determines how the transformation flow processes the data.
• UserDefinedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the transform flow is user-defined.
• VariantNumber: integer (int32)
  Default Value: 0

  Number of the transform flow variant.
• VersionLabel: string
  Read Only: true

  Maximum Length: 30

  Label for the version of the transform flow variant.
• VersionNumber: integer (int32)
  Default Value: 1

  Number for the version of the transform flow variant.
• XformFlowDefId: integer (int64)
  Unique identifier of the transformation flow definition.
• XformFlowId: integer (int64)
  Read Only: true

  Unique identifier of the transformation flow.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the variant is active. Contains one of these values: true or false. If true, then the variant is active. If false, then the variant isn't active. This attribute doesn't have a default value.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the document for which the transformation flow is set up.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingFile":{
            "type":"string",
            "description":"File that contains the mapping definition for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFileName":{
            "type":"string",
            "description":"Name of the mapping file.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingFunctionsFile":{
            "type":"string",
            "description":"File that contains the mapping functions for the transformation flow.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MappingFunctionsFilename":{
            "type":"string",
            "description":"Name of the file that contains the mapping functions.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ModifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ModifiedOn":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ParentFlowId":{
            "type":"integer",
            "description":"Unique identifier of the parent transformation flow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the transform flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the transform flow status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformMode":{
            "type":"string",
            "description":"Mode that determines how the transformation flow processes the data.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transform flow is user-defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VariantNumber":{
            "type":"integer",
            "description":"Number of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "VersionLabel":{
            "maxLength":30,
            "type":"string",
            "description":"Label for the version of the transform flow variant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "type":"integer",
            "description":"Number for the version of the transform flow variant.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "XformFlowDefId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "XformFlowId":{
            "type":"integer",
            "description":"Unique identifier of the transformation flow.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

transformFlow

Operation: /fscmRestApi/resources/11.13.18.05/transformationFlows/{XformFlowDefId}/child/transformFlow

Parameters:

• XformFlowDefId: $request.path.XformFlowDefId

A specific version of a Transformation Flow Definition. It contains the transformation artifacts such as mapping file and mapping function file required to transform a source business message into the target format.

Back to Top