Jump to

• Request
• Response

Create a formula step

post

/crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaSteps

Request

Path Parameters

• FormulaPlanPuid(required): string
  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: 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

• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The alternate identifier of the balance code.
• BalanceCodeId: integer (int64)
  The unique identifier of the balance code.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• ChargeOutcomeFlag: boolean
  Title: Update Charge

  Maximum Length: 1

  Indicates the charge outcome of the formula step.
• FormulaExpression: string
  Title: Formula Builder

  Maximum Length: 4000

  The expression used to define the formula step.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the formula step.
• FormulaStepId: integer (int64)
  The unique identifier of the formula step.
• FormulaStepPuid: string
  Maximum Length: 120

  The public unique identifier of the formula step.
• NegotiableFlag: boolean
  Maximum Length: 1

  Indicates if the formula step is negotiable.
• OutcomeVariable: string
  Title: Step Name

  Maximum Length: 30

  The name of the outcome variable used in the formula step.
• SequenceNumber: integer (int64)
  Title: Step Sequence

  The sequence number that determines the order in which the step is executed.
• StepName: string
  Maximum Length: 200

  The name of the formula step.

{
    "type":"object",
    "properties":{
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the balance code.",
            "nullable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeOutcomeFlag":{
            "title":"Update Charge",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the charge outcome of the formula step.",
            "nullable":true
        },
        "FormulaExpression":{
            "title":"Formula Builder",
            "maxLength":4000,
            "type":"string",
            "description":"The expression used to define the formula step.",
            "nullable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the formula step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FormulaStepId":{
            "type":"integer",
            "description":"The unique identifier of the formula step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FormulaStepPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the formula step.",
            "nullable":false
        },
        "NegotiableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the formula step is negotiable.",
            "nullable":true
        },
        "OutcomeVariable":{
            "title":"Step Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the outcome variable used in the formula step.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Step Sequence",
            "type":"integer",
            "description":"The sequence number that determines the order in which the step is executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StepName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the formula step.",
            "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 : subscriptionFormulaPlans-formulaSteps-item-response

Type: object

Show Source

• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The alternate identifier of the balance code.
• BalanceCodeId: integer (int64)
  The unique identifier of the balance code.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• ChargeOutcomeFlag: boolean
  Title: Update Charge

  Maximum Length: 1

  Indicates the charge outcome of the formula step.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• FormulaExpression: string
  Title: Formula Builder

  Maximum Length: 4000

  The expression used to define the formula step.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the formula step.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the formula plan associated with this formula step.
• FormulaStepId: integer (int64)
  The unique identifier of the formula step.
• FormulaStepPuid: string
  Maximum Length: 120

  The public unique identifier of the formula step.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier used for the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiableFlag: boolean
  Maximum Length: 1

  Indicates if the formula step is negotiable.
• OutcomeVariable: string
  Title: Step Name

  Maximum Length: 30

  The name of the outcome variable used in the formula step.
• SequenceNumber: integer (int64)
  Title: Step Sequence

  The sequence number that determines the order in which the step is executed.
• StepName: string
  Maximum Length: 200

  The name of the formula step.

{
    "type":"object",
    "properties":{
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeOutcomeFlag":{
            "title":"Update Charge",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the charge outcome of the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaExpression":{
            "title":"Formula Builder",
            "maxLength":4000,
            "type":"string",
            "description":"The expression used to define the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the formula step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the formula plan associated with this formula step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaStepId":{
            "type":"integer",
            "description":"The unique identifier of the formula step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaStepPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the formula step.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the formula step is negotiable.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeVariable":{
            "title":"Step Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the outcome variable used in the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Step Sequence",
            "type":"integer",
            "description":"The sequence number that determines the order in which the step is executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StepName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the formula step.",
            "nullable":true,
            "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"
    }
}

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