Jump to

• Request
• Response
• Examples

Create a service disposition

post

/services/rest/connect/v1.4/serviceDispositions

Request

Body ()

The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.

Root Schema : serviceDispositions

Type: object

The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.

Show Source

• adminVisibleInterfaces: object namedIDs-serviceDispositions-adminVisibleInterfaces
  The named ID that can be included in a list.
• createdTime: string
  The date and time when the service disposition was created. This attribute is read-only.
• descriptions: object serviceDispositions-descriptions
  The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the service disposition relative to other dispositions with the same parent.
• dispositionHierarchy: array dispositionHierarchy
  The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the service disposition.
• lookupName: string
  Maximum Length: 255

  The name used to look up the service disposition.
• name: string
  Maximum Length: 80

  The name of the service disposition in the language of the current interface. This attribute is read-only.
• names: object serviceDispositions-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• parent: [ "object", "null" ]
  The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resource.
• productLinks: object serviceDispositions-productLinks
  The product linking for a category or a disposition.
• updatedTime: string
  The date and time when the service disposition was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the service disposition was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the service disposition in the language of the current interface. This attribute is read-only.",
            "maxLength":"80"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the service disposition.",
            "maxLength":"255"
        },
        "descriptions":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of descriptions, one for each supported language.",
            "$ref":"#/definitions/serviceDispositions-descriptions"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the service disposition was created. This attribute is read-only."
        },
        "dispositionHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the disposition is available for administration use.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-adminVisibleInterfaces"
        },
        "productLinks":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The disposition to product linking.",
            "$ref":"#/definitions/serviceDispositions-productLinks"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the service disposition.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position of the service disposition relative to other dispositions with the same parent.",
            "maximum":"2147483647"
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/serviceDispositions-names"
        }
    }
}

Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

Nested Schema : serviceDispositions-descriptions

Type: object

The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.

Show Source

• labelText: [ "string", "null" ]
  Maximum Length: 1333

  The label text.
• language: object namedIDs-serviceDispositions-descriptions-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":[
                "string",
                "null"
            ],
            "description":"The label text.",
            "maxLength":"1333"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-descriptions-language"
        }
    }
}

Nested Schema : dispositionHierarchy

Type: array

The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array",
    "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : serviceDispositions-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-serviceDispositions-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-names-language"
        }
    }
}

Nested Schema : serviceDispositions-productLinks

Type: object

The product linking for a category or a disposition.

Show Source

• serviceProduct: object serviceProduct
  The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.

{
    "type":"object",
    "description":"The product linking for a category or a disposition.",
    "properties":{
        "serviceProduct":{
            "type":"object",
            "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource."
        }
    }
}

Nested Schema : namedIDs-serviceDispositions-descriptions-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : namedIDs-serviceDispositions-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : serviceProduct

Type: object

The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.

Back to Top

Response

Default Response

Body ()

Root Schema : serviceDispositions

Type: object

The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.

Show Source

• adminVisibleInterfaces: object namedIDs-serviceDispositions-adminVisibleInterfaces
  The named ID that can be included in a list.
• createdTime: string
  The date and time when the service disposition was created. This attribute is read-only.
• descriptions: object serviceDispositions-descriptions
  The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the service disposition relative to other dispositions with the same parent.
• dispositionHierarchy: array dispositionHierarchy
  The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the service disposition.
• lookupName: string
  Maximum Length: 255

  The name used to look up the service disposition.
• name: string
  Maximum Length: 80

  The name of the service disposition in the language of the current interface. This attribute is read-only.
• names: object serviceDispositions-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• parent: [ "object", "null" ]
  The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resource.
• productLinks: object serviceDispositions-productLinks
  The product linking for a category or a disposition.
• updatedTime: string
  The date and time when the service disposition was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the service disposition was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the service disposition in the language of the current interface. This attribute is read-only.",
            "maxLength":"80"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the service disposition.",
            "maxLength":"255"
        },
        "descriptions":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of descriptions, one for each supported language.",
            "$ref":"#/definitions/serviceDispositions-descriptions"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the service disposition was created. This attribute is read-only."
        },
        "dispositionHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the disposition is available for administration use.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-adminVisibleInterfaces"
        },
        "productLinks":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The disposition to product linking.",
            "$ref":"#/definitions/serviceDispositions-productLinks"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the service disposition.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position of the service disposition relative to other dispositions with the same parent.",
            "maximum":"2147483647"
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/serviceDispositions-names"
        }
    }
}

Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

Nested Schema : serviceDispositions-descriptions

Type: object

The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.

Show Source

• labelText: [ "string", "null" ]
  Maximum Length: 1333

  The label text.
• language: object namedIDs-serviceDispositions-descriptions-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":[
                "string",
                "null"
            ],
            "description":"The label text.",
            "maxLength":"1333"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-descriptions-language"
        }
    }
}

Nested Schema : dispositionHierarchy

Type: array

The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array",
    "description":"The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : serviceDispositions-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-serviceDispositions-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceDispositions-names-language"
        }
    }
}

Nested Schema : serviceDispositions-productLinks

Type: object

The product linking for a category or a disposition.

Show Source

• serviceProduct: object serviceProduct
  The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.

{
    "type":"object",
    "description":"The product linking for a category or a disposition.",
    "properties":{
        "serviceProduct":{
            "type":"object",
            "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource."
        }
    }
}

Nested Schema : namedIDs-serviceDispositions-descriptions-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : namedIDs-serviceDispositions-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : serviceProduct

Type: object

The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.

Back to Top

Examples

Use POST with the following syntax to create a new service disposition object:

https://your_site_interface/services/rest/connect/version/serviceDispositions

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions

Request body example

{
"names": [
    {
    "labelText": "Returned",
    "language":
        {
        "id":1
        }
    },
    {
    "labelText": "Renvoyé",
    "language":
        {
        "id":8
        }
    }
    ],
"parent":
    {
    "id":39
    }
}

Note:

The names array is required for service dispositions. It contains a list of names, one for each supported language.

Response body example

{
  "id": 69,
  "lookupName": "Returned",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69/
         adminVisibleInterfaces"
      }
    ]
  },
  "descriptions": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69/
         descriptions"
      }
    ]
  },
  "displayOrder": 1,
  "dispositionHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69/
         dispositionHierarchy"
      }
    ]
  },
  "name": "Returned",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69/names"
      }
    ]
  },
  "parent": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/39"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/39"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
         serviceDispositions",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "productLinks": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69/
         productLinks"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/69"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
       serviceDispositions",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top