Jump to

• Request
• Response

Update a link

patch

/crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}

Request

Path Parameters

• LinkNumber(required): string
  The unique identifier of the link.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 240

  The description of the link.
• LinkMember: array Link Members
  Title: Link Members

  The link member resource is used to view, create, and update the members of a link.
• LinkStatus: string
  Maximum Length: 60

  Default Value: A

  The status of a link. The list of accepted values are A (active) and I (inactive).

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the link.",
            "nullable":true
        },
        "LinkMember":{
            "title":"Link Members",
            "type":"array",
            "description":"The link member resource is used to view, create, and update the members of a link.",
            "items":{
                "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-patch-request"
            }
        },
        "LinkStatus":{
            "maxLength":60,
            "type":"string",
            "description":"The status of a link. The list of accepted values are A (active) and I (inactive).",
            "nullable":false,
            "default":"A"
        }
    }
}

Nested Schema : Link Members

Type: array

Title: Link Members

The link member resource is used to view, create, and update the members of a link.

Show Source

• Array of: object resolutionLinks-LinkMember-item-patch-request

{
    "title":"Link Members",
    "type":"array",
    "description":"The link member resource is used to view, create, and update the members of a link.",
    "items":{
        "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-patch-request"
    }
}

Nested Schema : resolutionLinks-LinkMember-item-patch-request

Type: object

Show Source

• MasterFlag: boolean
  Maximum Length: 1

  The master member of the link.
• MemberStatus: string
  The status of a link member.The list of accepted values are A (active) and I (inactive).

{
    "type":"object",
    "properties":{
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The master member of the link.",
            "nullable":false
        },
        "MemberStatus":{
            "type":"string",
            "description":"The status of a link member.The list of accepted values are A (active) and I (inactive).",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the link.
• CreationDate: string (date-time)
  Read Only: true

  The date when the link was created.
• Description: string
  Maximum Length: 240

  The description of the link.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the link was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the link.
• LinkId: integer (int64)
  Read Only: true

  The unique primary identifier of the link.
• LinkMember: array Link Members
  Title: Link Members

  The link member resource is used to view, create, and update the members of a link.
• LinkName: string
  Maximum Length: 128

  The name of the link.
• LinkNumber: string
  Maximum Length: 64

  The unique identifier of the link.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkStatus: string
  Maximum Length: 60

  Default Value: A

  The status of a link. The list of accepted values are A (active) and I (inactive).
• PartyType: string
  Maximum Length: 30

  The party type that defines whether the party is an organization, a person, a contact or any other user-defined party type.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the link was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the link.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the link was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"The unique primary identifier of the link.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkMember":{
            "title":"Link Members",
            "type":"array",
            "description":"The link member resource is used to view, create, and update the members of a link.",
            "items":{
                "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-response"
            }
        },
        "LinkName":{
            "maxLength":128,
            "type":"string",
            "description":"The name of the link.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the link.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkStatus":{
            "maxLength":60,
            "type":"string",
            "description":"The status of a link. The list of accepted values are A (active) and I (inactive).",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"The party type that defines whether the party is an organization, a person, a contact or any other user-defined party type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Link Members

Type: array

Title: Link Members

The link member resource is used to view, create, and update the members of a link.

Show Source

• Array of: object resolutionLinks-LinkMember-item-response

{
    "title":"Link Members",
    "type":"array",
    "description":"The link member resource is used to view, create, and update the members of a link.",
    "items":{
        "$ref":"#/components/schemas/resolutionLinks-LinkMember-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 : resolutionLinks-LinkMember-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the link member.
• CreationDate: string (date-time)
  Read Only: true

  The date when the link member was created.
• DepartureDate: string (date)
  Read Only: true

  The date when the member was removed from the link.
• JoinDate: string (date)
  Read Only: true

  The date when the member joined the link.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the link member was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the link member.
• LinkNumber: string
  Read Only: true

  Maximum Length: 255

  The unique identifier of the link associated with the member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterFlag: boolean
  Maximum Length: 1

  The master member of the link.
• MemberStatus: string
  The status of a link member.The list of accepted values are A (active) and I (inactive).
• PartyId: integer
  The unique internal identifier of a link member. Either PartyId or PartyNumber is required to uniquely identify the link member record with which the link is associated.
• PartyName: string
  The name of the link member.
• PartyNumber: string
  The unique primary identifier for the link member.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the link member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartureDate":{
            "type":"string",
            "description":"The date when the member was removed from the link.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JoinDate":{
            "type":"string",
            "description":"The date when the member joined the link.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the link member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the link associated with the member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The master member of the link.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberStatus":{
            "type":"string",
            "description":"The status of a link member.The list of accepted values are A (active) and I (inactive).",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique internal identifier of a link member. Either PartyId or PartyNumber is required to uniquely identify the link member record with which the link is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "type":"string",
            "description":"The name of the link member.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The unique primary identifier for the link member.",
            "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."
        }
    }
}

Links

LinkMember

Operation: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember

Parameters:

• LinkNumber: $request.path.LinkNumber

The link member resource is used to view, create, and update the members of a link.

Back to Top