Jump to

• Request
• Response

Create one subscription term

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/subscriptionTerm

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.

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.
• Upsert-Mode:
  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

• SourceOrderTermId: string
  Maximum Length: 50

  Value that uniquely identifies the order term in the source application.
• TermAdjustmentPercent: number
  Percent of adjustment for the term.
• TermApplicationMethod: string
  Maximum Length: 80

  Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.
• TermApplicationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.
• TermDuration: number
  Duration for the subscription term.
• TermPeriod: string
  Maximum Length: 25

  Name of the time unit of measure for the subscription term.
• TermPeriodCode: string
  Maximum Length: 15

  Abbreviation that identifies the time unit of measure for the subscription term.
• TermStartDate: string (date-time)
  Date when the subscription term starts.

{
    "type":"object",
    "properties":{
        "SourceOrderTermId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the order term in the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TermApplicationMethod":{
            "maxLength":80,
            "type":"string",
            "description":"Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.",
            "nullable":true
        },
        "TermPeriod":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the time unit of measure for the subscription term.",
            "nullable":true
        },
        "TermAdjustmentPercent":{
            "type":"number",
            "description":"Percent of adjustment for the term.",
            "nullable":true
        },
        "TermStartDate":{
            "type":"string",
            "description":"Date when the subscription term starts.",
            "format":"date-time",
            "nullable":true
        },
        "TermApplicationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.",
            "nullable":true
        },
        "TermDuration":{
            "type":"number",
            "description":"Duration for the subscription term.",
            "nullable":true
        },
        "TermPeriodCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the time unit of measure for the subscription term.",
            "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(required):
  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(required):
  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 : salesOrdersForOrderHubRequests-lines-subscriptionTerm-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceOrderTermId: string
  Maximum Length: 50

  Value that uniquely identifies the order term in the source application.
• TermAdjustmentPercent: number
  Percent of adjustment for the term.
• TermApplicationMethod: string
  Maximum Length: 80

  Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.
• TermApplicationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.
• TermDuration: number
  Duration for the subscription term.
• TermPeriod: string
  Maximum Length: 25

  Name of the time unit of measure for the subscription term.
• TermPeriodCode: string
  Maximum Length: 15

  Abbreviation that identifies the time unit of measure for the subscription term.
• TermStartDate: string (date-time)
  Date when the subscription term starts.

{
    "type":"object",
    "properties":{
        "SourceOrderTermId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the order term in the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TermApplicationMethod":{
            "maxLength":80,
            "type":"string",
            "description":"Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.",
            "nullable":true,
            "x-queryable":true
        },
        "TermPeriod":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the time unit of measure for the subscription term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermAdjustmentPercent":{
            "type":"number",
            "description":"Percent of adjustment for the term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermStartDate":{
            "type":"string",
            "description":"Date when the subscription term starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TermApplicationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TermDuration":{
            "type":"number",
            "description":"Duration for the subscription term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermPeriodCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the time unit of measure for the subscription term.",
            "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