Create an instance of serviceDispositions

post

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

Request

Body ()
Hierarchical service disposition
Root Schema : serviceDispositions
Type: object
Hierarchical service disposition
Show Source
Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceDispositions-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : serviceDispositions-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
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
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
Nested Schema : serviceProducts
Type: object
Hierarchical service product
Show Source
Nested Schema : namedIDs-serviceProducts-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceProducts-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : serviceCategories
Type: object
Hierarchical service category
Show Source
Nested Schema : namedIDs-serviceCategories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceCategories-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-serviceCategories-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
Nested Schema : namedIDs-serviceCategories-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
Nested Schema : namedIDs-serviceProducts-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
Nested Schema : namedIDs-serviceProducts-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

Response

Default Response

Body ()
Hierarchical service disposition
Root Schema : serviceDispositions
Type: object
Hierarchical service disposition
Show Source
Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceDispositions-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : serviceDispositions-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
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
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
Nested Schema : serviceProducts
Type: object
Hierarchical service product
Show Source
Nested Schema : namedIDs-serviceProducts-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceProducts-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : serviceCategories
Type: object
Hierarchical service category
Show Source
Nested Schema : namedIDs-serviceCategories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceCategories-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-serviceCategories-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
Nested Schema : namedIDs-serviceCategories-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
Nested Schema : namedIDs-serviceProducts-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
Nested Schema : namedIDs-serviceProducts-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

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"
    }
  ]
}