Jump to

• Request
• Response

Create an usage event batch error

post

/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEventBatchErrors

Request

Path Parameters

• BatchNumber(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

• BatchId: integer (int64)
  Title: Batch ID

  The unique batch identifier of the specific usage event batch.
• BatchNumber: string
  Title: Batch

  Maximum Length: 120

  The batch number of the specific usage event batch.
• CountOfErroredEvents: integer
  Title: Events with Errors

  Count of events having errors in the batch.
• EventBatchErrorId: integer (int64)
  The unique identifier of usage event batch error.
• EventBatchErrorNumber: string
  Title: Event Batch Error Number

  Maximum Length: 120

  The alternate unique identifier of usage event batch error.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  The message name for the usage event batch error.

{
    "type":"object",
    "properties":{
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The unique batch identifier of the specific usage event batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BatchNumber":{
            "title":"Batch",
            "maxLength":120,
            "type":"string",
            "description":"The batch number of the specific usage event batch.",
            "nullable":false
        },
        "CountOfErroredEvents":{
            "title":"Events with Errors",
            "type":"integer",
            "description":"Count of events having errors in the batch.",
            "nullable":true,
            "x-queryable":false
        },
        "EventBatchErrorId":{
            "type":"integer",
            "description":"The unique identifier of usage event batch error.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventBatchErrorNumber":{
            "title":"Event Batch Error Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of usage event batch error.",
            "nullable":false
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":30,
            "type":"string",
            "description":"The message name for the usage event batch error.",
            "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 : subscriptionUsageEventBatches-usageEventBatchErrors-item-response

Type: object

Show Source

• BatchId: integer (int64)
  Title: Batch ID

  The unique batch identifier of the specific usage event batch.
• BatchNumber: string
  Title: Batch

  Maximum Length: 120

  The batch number of the specific usage event batch.
• CountOfErroredEvents: integer
  Title: Events with Errors

  Count of events having errors in the batch.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created a usage event batch error.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when a usage event batch error was created.
• EventBatchErrorId: integer (int64)
  The unique identifier of usage event batch error.
• EventBatchErrorNumber: string
  Title: Event Batch Error Number

  Maximum Length: 120

  The alternate unique identifier of usage event batch error.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when an usage event batch error was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who has last updated a usage event batch error.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  The message name for the usage event batch error.
• MessageText: string
  Title: Error

  Read Only: true

  Maximum Length: 240

  The message text for the usage event batch error.
• MessageUserDetails: string
  Title: Recommendation

  Read Only: true

  Maximum Length: 4000

  Recommendation based on the message text.

{
    "type":"object",
    "properties":{
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The unique batch identifier of the specific usage event batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch",
            "maxLength":120,
            "type":"string",
            "description":"The batch number of the specific usage event batch.",
            "nullable":false,
            "x-queryable":true
        },
        "CountOfErroredEvents":{
            "title":"Events with Errors",
            "type":"integer",
            "description":"Count of events having errors in the batch.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created a usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when a usage event batch error was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventBatchErrorId":{
            "type":"integer",
            "description":"The unique identifier of usage event batch error.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventBatchErrorNumber":{
            "title":"Event Batch Error Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of usage event batch error.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when an usage event batch error was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated a usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":30,
            "type":"string",
            "description":"The message name for the usage event batch error.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Error",
            "maxLength":240,
            "type":"string",
            "description":"The message text for the usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageUserDetails":{
            "title":"Recommendation",
            "maxLength":4000,
            "type":"string",
            "description":"Recommendation based on the message text.",
            "nullable":true,
            "readOnly":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