Jump to

• Request
• Response

Update a link type

patch

/crmRestApi/resources/11.13.18.05/svcLinkTypes/{LinkTypeNumber}

Request

Path Parameters

• LinkTypeNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• DeletedFlag: boolean
  Title: Deleted Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the link type is logically deleted. The values are Y and N.
• LinkFormat: string
  Title: Format

  Maximum Length: 2000

  The format of the link type. It may contain one or more token names that can be substituted.
• LinkTypeDescription: string
  Title: Description

  Maximum Length: 512

  The description of the link type entered by the administrator user when it's created.
• LinkTypeName: string
  Title: Name

  Maximum Length: 64

  The link type name provided by the Administrator.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "title":"Deleted Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the link type is logically deleted. The values are Y and N.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "LinkTypeDescription":{
            "title":"Description",
            "maxLength":512,
            "type":"string",
            "description":"The description of the link type entered by the administrator user when it's created.",
            "nullable":true
        },
        "LinkTypeName":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"The link type name provided by the Administrator.",
            "nullable":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 : svcLinkTypes-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.
• DeletedFlag: boolean
  Title: Deleted Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the link type is logically deleted. The values are Y and N.
• 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 type was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the row.
• LinkFormat: string
  Title: Format

  Maximum Length: 2000

  The format of the link type. It may contain one or more token names that can be substituted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkTypeCd: string
  Title: Code

  Maximum Length: 64

  The code for the link type. A unique code that 's human readable.
• LinkTypeDescription: string
  Title: Description

  Maximum Length: 512

  The description of the link type entered by the administrator user when it's created.
• LinkTypeId: integer (int64)
  Title: ID

  Read Only: true

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

  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.
• UpdateFlag: boolean
  Read Only: true

  Flag that indicates if the user has access to update the record.

{
    "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
        },
        "DeletedFlag":{
            "title":"Deleted Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the link type is logically deleted. The values are Y and N.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the link type 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 type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "x-queryable":true
        },
        "LinkTypeCd":{
            "title":"Code",
            "maxLength":64,
            "type":"string",
            "description":"The code for the link type. A unique code that 's human readable.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "LinkTypeName"
                ]
            },
            "x-queryable":true
        },
        "LinkTypeDescription":{
            "title":"Description",
            "maxLength":512,
            "type":"string",
            "description":"The description of the link type entered by the administrator user when it's created.",
            "nullable":true,
            "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,
            "readOnly":true,
            "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,
            "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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Flag that indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: DeletedFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top