Jump to

• Request
• Response

Create a collection of all point blocks

post

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks

Request

Path Parameters

• LoyProgramId(required): integer(int64)
  The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Name: string
  Title: Name

  Maximum Length: 100

  The name of point block. There is no default value, dependency, or limitation associated with this attribute.
• OriginalPoints: number
  Title: Original Points

  The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.
• Partner: string
  Title: Partner

  The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.
• PointBlockNumber: string
  Title: Point Block Number

  Maximum Length: 30

  The number of point block. There is no default value, dependency, or limitation associated with this attribute.
• ProgPointBlockId: integer (int64)
  The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.
• StartDate: string (date-time)
  Title: Start Date

  The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "PointBlockNumber":{
            "title":"Point Block Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false
        },
        "OriginalPoints":{
            "title":"Original Points",
            "type":"number",
            "description":"The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false
        },
        "ProgPointBlockId":{
            "type":"integer",
            "description":"The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Partner":{
            "title":"Partner",
            "type":"string",
            "description":"The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "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(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 : loyPrograms-PointBlocks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that created the point block. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the point block is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the point block record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point block record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the point block. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 100

  The name of point block. There is no default value, dependency, or limitation associated with this attribute.
• OriginalPoints: number
  Title: Original Points

  The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.
• Partner: string
  Title: Partner

  The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.
• PointBlockNumber: string
  Title: Point Block Number

  Maximum Length: 30

  The number of point block. There is no default value, dependency, or limitation associated with this attribute.
• ProgPointBlockId: integer (int64)
  The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The name of program for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.
• RemainingPoints: number
  Title: Remaining Points

  Read Only: true

  The remaining points from the point block. There is no default value, dependency, or limitation associated with this attribute.
• StartDate: string (date-time)
  Title: Start Date

  The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the point block. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointBlockNumber":{
            "title":"Point Block Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the point block is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalPoints":{
            "title":"Original Points",
            "type":"number",
            "description":"The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the point block. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgPointBlockId":{
            "type":"integer",
            "description":"The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of program for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RemainingPoints":{
            "title":"Remaining Points",
            "type":"number",
            "description":"The remaining points from the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Partner":{
            "title":"Partner",
            "type":"string",
            "description":"The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the point block record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point block record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":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