Jump to

• Request
• Response

Get all links

get

/crmRestApi/resources/11.13.18.05/svcLinks

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
  
  

  • LinkByLinkNumber Finds a link with the specified link number.
    Finder Variables
    • LinkNumber; string; An alternate unique identifier of the link.
  • PrimaryKey Finds a link with the specified primary key.
    Finder Variables
    • LinkId; integer; The unique identifier of the link.
• 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 row.
  • CreationDate; string; The date when the row was created.
  • LastUpdateDate; string; The date when the link was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the row.
  • LastUpdatedBy; string; The user who last updated the link.
  • LinkFormat; string; The format of the link type. It may contain one or more token names that can be substituted.
  • LinkId; integer; The identifier attribute the primary key attribute for the link data.
  • LinkNumber; string; An alternate unique identifier for the link. Links are searched through this attribute in rest calls.
  • LinkTypeId; integer; Identifier for the link type which is an auto generated primary key attribute.
  • LinkTypeName; string; The link type name provided by the Administrator.
  • LinkTypeNumber; string; An alternate unique identifier of the link type which is an auto generated PUID attribute.
  • LinkValue; string; User input value for the link which captures the complete URI of the web resource in case of a static resource or a JSON string with token values.
  • ObjectId; integer; The identifier of the related object. This is usually the link's parent object's primary key attribute to which the link is associated.
  • ObjectReferenceNumber; string; The reference value of the related object which is the unique PUID of the parent object to which the link is associated.
  • ObjectTypeCd; string; The lookup code which indicates the type of the related object. The type of the parent object to which this link is associated.
  • WebLink; string; The ready-to-use link value formed by replacing the tokens in the link format with token values at run time.
• 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: 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 : svcLinks

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/svcLinks-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object svcLinks-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/svcLinks-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 : svcLinks-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the row was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user has access to delete the record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the link was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the link.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the row.
• LinkDescription: string
  Title: Description

  Maximum Length: 512

  The description of the link which is supplied by the agent user describing the link associated to the parent object.
• LinkFormat: string
  Title: Format

  Read Only: true

  Maximum Length: 2000

  The format of the link type. It may contain one or more token names that can be substituted.
• LinkId: integer (int64)
  Title: ID

  Read Only: true

  The identifier attribute the primary key attribute for the link data.
• LinkNumber: string
  Title: Link Number

  Maximum Length: 64

  An alternate unique identifier for the link. Links are searched through this attribute in rest calls.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkTypeId: integer (int64)
  Title: ID

  Identifier for the link type which is an auto generated primary key attribute.
• LinkTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 64

  The link type name provided by the Administrator.
• LinkTypeNumber: string
  Title: Type Number

  Maximum Length: 64

  An alternate unique identifier of the link type which is an auto generated PUID attribute.
• LinkValue: string
  Title: Value

  Maximum Length: 2000

  User input value for the link which captures the complete URI of the web resource in case of a static resource or a JSON string with token values.
• ObjectId: integer (int64)
  Title: Object ID

  The identifier of the related object. This is usually the link's parent object's primary key attribute to which the link is associated.
• ObjectReferenceNumber: string
  Title: Object Reference Number

  Maximum Length: 64

  The reference value of the related object which is the unique PUID of the parent object to which the link is associated.
• ObjectTypeCd: string
  Title: Object Type Code

  Maximum Length: 30

  The lookup code which indicates the type of the related object. The type of the parent object to which this link is associated.
• ObjectTypeCdMeaning: string
  Title: Object Type Value

  Read Only: true

  Maximum Length: 255

  The display value of the object type lookup code.
• UpdateFlag: boolean
  Read Only: true

  Flag that indicates if the user has access to update the record.
• WebLink: string
  Title: Web Link

  The ready-to-use link value formed by replacing the tokens in the link format with token values at run time.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the link 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 who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkDescription":{
            "title":"Description",
            "maxLength":512,
            "type":"string",
            "description":"The description of the link which is supplied by the agent user describing the link associated to the parent object.",
            "nullable":false,
            "x-queryable":false
        },
        "LinkFormat":{
            "title":"Format",
            "maxLength":2000,
            "type":"string",
            "description":"The format of the link type. It may contain one or more token names that can be substituted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkId":{
            "title":"ID",
            "type":"integer",
            "description":"The identifier attribute the primary key attribute for the link data.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkNumber":{
            "title":"Link Number",
            "maxLength":64,
            "type":"string",
            "description":"An alternate unique identifier for the link. Links are searched through this attribute in rest calls.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkTypeId":{
            "title":"ID",
            "type":"integer",
            "description":"Identifier for the link type which is an auto generated primary key attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkTypeName":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"The link type name provided by the Administrator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeNumber":{
            "title":"Type Number",
            "maxLength":64,
            "type":"string",
            "description":"An alternate unique identifier of the link type which is an auto generated PUID attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkValue":{
            "title":"Value",
            "maxLength":2000,
            "type":"string",
            "description":"User input value for the link which captures the complete URI of the web resource in case of a static resource or a JSON string with token values.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The identifier of the related object. This is usually the link's parent object's primary key attribute to which the link is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectReferenceNumber":{
            "title":"Object Reference Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference value of the related object which is the unique PUID of the parent object to which the link is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code which indicates the type of the related object. The type of the parent object to which this link is associated.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectTypeCdMeaning":{
            "title":"Object Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the object type lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectTypeCd"
                ]
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Flag that indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WebLink":{
            "title":"Web Link",
            "type":"string",
            "description":"The ready-to-use link value formed by replacing the tokens in the link format with token values at run time.",
            "nullable":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