Jump to

• Request
• Response

Get an outcome

get

/crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}

Request

Path Parameters

• LookupCode(required): string
  The lookup code for the resolve outcome.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : internalSRResolveOutcomeLookups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resolve outcome lookup value.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resolve outcome lookup value was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the resolve outcome lookup.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  Read Only: true

  The display sequence in the list of resolve outcomes.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the resolve outcome is enabled.
• EndDateActive: string (date)
  Title: End Date

  Read Only: true

  The date and time when the resolve outcome lookup value will end.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resolve outcome lookup value was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resolve outcome lookup value.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user that last updated the resolve outcome lookup value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: SR Outcome Code

  Read Only: true

  Maximum Length: 30

  The lookup code for the resolve outcome.
• LookupType: string
  Title: SR Outcome Type

  Read Only: true

  Maximum Length: 255

  The lookup type for the resolve outcome.
• Meaning: string
  Title: SR Outcome Meaning

  Read Only: true

  Maximum Length: 80

  The lookup meaning for the resolve outcome.
• srResolutionLookups: array Internal Service Request Outcome Resolutions
  Title: Internal Service Request Outcome Resolutions

  The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.
• StartDateActive: string (date)
  Title: Start Date

  Read Only: true

  The date and time when the resolve outcome lookup value will be active.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resolve outcome lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the resolve outcome lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence in the list of resolve outcomes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resolve outcome is enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value will end.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user that last updated the resolve outcome lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resolve outcome lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"SR Outcome Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"SR Outcome Type",
            "maxLength":255,
            "type":"string",
            "description":"The lookup type for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"SR Outcome Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The lookup meaning for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value will be active.",
            "format":"date",
            "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"
            }
        },
        "srResolutionLookups":{
            "title":"Internal Service Request Outcome Resolutions",
            "type":"array",
            "description":"The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.",
            "items":{
                "$ref":"#/components/schemas/internalSRResolveOutcomeLookups-srResolutionLookups-item-response"
            }
        }
    }
}

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 : Internal Service Request Outcome Resolutions

Type: array

Title: Internal Service Request Outcome Resolutions

The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.

Show Source

• Array of: object internalSRResolveOutcomeLookups-srResolutionLookups-item-response

{
    "title":"Internal Service Request Outcome Resolutions",
    "type":"array",
    "description":"The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.",
    "items":{
        "$ref":"#/components/schemas/internalSRResolveOutcomeLookups-srResolutionLookups-item-response"
    }
}

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

Nested Schema : internalSRResolveOutcomeLookups-srResolutionLookups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resolve outcome resolution lookup value.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resolve outcome lookup value was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the resolve outcome lookup value.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  Read Only: true

  The display sequence in the list of resolve outcomes.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the resolve outcome resolution is enabled.
• EndDateActive: string (date)
  Title: End Date

  Read Only: true

  The date and time when the resolve outcome resolution lookup value will be end dated.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resolve outcome resolution lookup value was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resolve outcome resolution lookup value.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user that last updated the resolve outcome resolution lookup value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: SR Resolution Code

  Read Only: true

  Maximum Length: 30

  The lookup code for the resolve outcome resolution.
• Meaning: string
  Title: SR Resolution Meaning

  Read Only: true

  Maximum Length: 80

  The lookup type for the resolve outcome resolution.
• ParentLookupCode: string
  Title: SR Outcome Code

  Read Only: true

  Maximum Length: 255

  The lookup meaning for the resolve outcome resolution.
• StartDateActive: string (date)
  Title: Start Date

  Read Only: true

  The date and time when the resolve outcome resolution lookup value will be active.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resolve outcome resolution lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the resolve outcome lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence in the list of resolve outcomes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resolve outcome resolution is enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value will be end dated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user that last updated the resolve outcome resolution lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resolve outcome resolution lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"SR Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"SR Resolution Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The lookup type for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLookupCode":{
            "title":"SR Outcome Code",
            "maxLength":255,
            "type":"string",
            "description":"The lookup meaning for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value will be active.",
            "format":"date",
            "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"
    }
}

Links

srResolutionLookups

Operation: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups

Parameters:

• LookupCode: $request.path.LookupCode

The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.

Back to Top