Jump to

• Request
• Response

Create a subscription coverage availability break

post

/crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak

Request

Path Parameters

• AvailabilityPuid(required): string
  The public unique identifier ot the availbility.
• IntervalPuid(required): string
  The public unique identifier of the interval.
• SchedulePuid(required): string
  The public unique identifier of the subscription coverage schedule.

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

• AvailabilityId: integer (int64)
  The unique identifier of the availability.
• BreakId: integer (int64)
  The unique identifier of the break
• BreakPuid: string
  Maximum Length: 120

  The public unique identifier of the break.
• EndHour: number
  The end hour of the break.
• EndMinute: number
  The end minute of the break.
• ObjectCode: string
  Maximum Length: 30

  The code associated with the object.
• StartHour: number
  The start hour of the break.
• StartMinute: number
  The start minute of the break.

{
    "type":"object",
    "properties":{
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BreakId":{
            "type":"integer",
            "description":"The unique identifier of the break",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BreakPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the break.",
            "nullable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the break.",
            "nullable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the break.",
            "nullable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the object.",
            "nullable":false
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the break.",
            "nullable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the break.",
            "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 : subscriptionCoverageSchedules-SubscriptionCoverageInterval-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response

Type: object

Show Source

• AvailabilityId: integer (int64)
  The unique identifier of the availability.
• AvailabilityPuid: string
  Read Only: true

  Maximum Length: 120

  The value that uniquely identifies the parent coverage availability against a break.
• BreakId: integer (int64)
  The unique identifier of the break
• BreakPuid: string
  Maximum Length: 120

  The public unique identifier of the break.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• EndHour: number
  The end hour of the break.
• EndMinute: number
  The end minute of the break.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

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

  The code associated with the object.
• StartHour: number
  The start hour of the break.
• StartMinute: number
  The start minute of the break.

{
    "type":"object",
    "properties":{
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailabilityPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the parent coverage availability against a break.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BreakId":{
            "type":"integer",
            "description":"The unique identifier of the break",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BreakPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the break.",
            "nullable":true,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the object.",
            "nullable":false,
            "x-queryable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the break.",
            "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