Jump to

• Request
• Response

Get all outcomes

get

/crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • IsEnabledFinder :Indicates whether the resolve outcome is enabled.
    Finder Variables:
  • PrimaryKey :Finds a resolve outcome with the specified primary key.
    Finder Variables:
    • LookupCode :Finds a resolve outcome lookup code with the specified primary key.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; The user who created the resolve outcome lookup value.
  • CreationDate; string; The date and time when the resolve outcome lookup value was created.
  • Description; string; The description of the resolve outcome lookup.
  • DisplaySequence; integer; The display sequence in the list of resolve outcomes.
  • EnabledFlag; boolean; Indicates whether the resolve outcome is enabled.
  • EndDateActive; string; The date and time when the resolve outcome lookup value will end.
  • LastUpdateDate; string; The date and time when the resolve outcome lookup value was last updated.
  • LastUpdateLogin; string; The login of the user that last updated the resolve outcome lookup value.
  • LastUpdatedBy; string; The user who last updated the resolve outcome lookup value.
  • LookupCode; string; The lookup code for the resolve outcome.
  • LookupType; string; The lookup type for the resolve outcome.
  • Meaning; string; The lookup meaning for the resolve outcome.
  • StartDateActive; string; The date and time when the resolve outcome lookup value will be active.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

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 : svcResolveOutcomeLookups

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/svcResolveOutcomeLookups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object svcResolveOutcomeLookups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/svcResolveOutcomeLookups-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 : svcResolveOutcomeLookups-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 Service Request Outcome Resolutions
  Title: Service Request Outcome Resolutions

  The Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for a 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":{
        "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
        },
        "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
        },
        "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
        },
        "LookupType":{
            "title":"SR Outcome Type",
            "maxLength":"255",
            "type":"string",
            "description":"The lookup type for the resolve outcome.",
            "nullable":false,
            "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
        },
        "srResolutionLookups":{
            "title":"Service Request Outcome Resolutions",
            "type":"array",
            "description":"The Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for a Service Request.",
            "items":{
                "$ref":"#/components/schemas/svcResolveOutcomeLookups-srResolutionLookups-item-response"
            }
        },
        "LookupCode":{
            "title":"SR Outcome Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the resolve outcome is enabled.",
            "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
        },
        "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
        }
    }
}

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

Type: array

Title: Service Request Outcome Resolutions

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

Show Source

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

{
    "title":"Service Request Outcome Resolutions",
    "type":"array",
    "description":"The Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for a Service Request.",
    "items":{
        "$ref":"#/components/schemas/svcResolveOutcomeLookups-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 : svcResolveOutcomeLookups-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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the resolve outcome resolution is enabled.",
            "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
        },
        "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
        },
        "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
        }
    }
}

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

Back to Top