Jump to

• Request
• Response

Update a service request reference

patch

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}

Request

Path Parameters

• ReferenceId(required): integer(int64)
  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=
• SrId(required): integer(int64)
  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

• ArticleId: string
  Title: Article ID

  Maximum Length: 64

  The unique identifier of the referenced article.
• ArticleLocale: string
  Title: Article Locale

  Maximum Length: 10

  The locale of the knowledge management article.
• HelpfulFlag: boolean
  Title: Helpful

  Maximum Length: 1

  Indicates whether the service request reference was helpful.
• LinkedFlag: boolean
  Title: Linked

  Maximum Length: 1

  Indicates whether the reference is linked with the service request.
• ObjectId: integer (int64)
  Title: Object ID

  Indicates whether the object is referenced to the service request.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The object type of the reference object.
• RelationTypeCd: string
  Title: Relation Type

  Maximum Length: 30

  The relationship type between the service request and the referenced object.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  Indicates whether the referenced object helps in resolving the service request.
• SharedFlag: boolean
  Title: Shared

  Maximum Length: 1

  Indicates whether the service request reference is shared with the customer.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• Subject: string
  Title: Title

  Maximum Length: 1000

  The title of the referenced object.

{
    "type":"object",
    "properties":{
        "ArticleId":{
            "title":"Article ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the referenced article.",
            "nullable":true
        },
        "ArticleLocale":{
            "title":"Article Locale",
            "maxLength":10,
            "type":"string",
            "description":"The locale of the knowledge management article.",
            "nullable":true
        },
        "HelpfulFlag":{
            "title":"Helpful",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference was helpful.",
            "nullable":true
        },
        "LinkedFlag":{
            "title":"Linked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the reference is linked with the service request.",
            "nullable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Indicates whether the object is referenced to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The object type of the reference object.",
            "nullable":false
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type between the service request and the referenced object.",
            "nullable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the referenced object helps in resolving the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SharedFlag":{
            "title":"Shared",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference is shared with the customer.",
            "nullable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Subject":{
            "title":"Title",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the referenced object.",
            "nullable":true
        }
    }
}

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 : internalServiceRequests-srReferences-item-response

Type: object

Show Source

• ArticleId: string
  Title: Article ID

  Maximum Length: 64

  The unique identifier of the referenced article.
• ArticleLocale: string
  Title: Article Locale

  Maximum Length: 10

  The locale of the knowledge management article.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the reference to the service request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the service request reference was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• DocumentId: string
  Title: Document ID

  Read Only: true

  Maximum Length: 50

  The unique document identifier associated with the referenced article.
• HelpfulFlag: boolean
  Title: Helpful

  Maximum Length: 1

  Indicates whether the service request reference was helpful.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the service request reference.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the service request reference.
• LinkedFlag: boolean
  Title: Linked

  Maximum Length: 1

  Indicates whether the reference is linked with the service request.
• links: array Links
  Title: Links

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

  Indicates whether the object is referenced to the service request.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The object type of the reference object.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the current reference record.
• RelationTypeCd: string
  Title: Relation Type

  Maximum Length: 30

  The relationship type between the service request and the referenced object.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  Indicates whether the referenced object helps in resolving the service request.
• SharedFlag: boolean
  Title: Shared

  Maximum Length: 1

  Indicates whether the service request reference is shared with the customer.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• Subject: string
  Title: Title

  Maximum Length: 1000

  The title of the referenced object.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record

{
    "type":"object",
    "properties":{
        "ArticleId":{
            "title":"Article ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the referenced article.",
            "nullable":true,
            "x-queryable":true
        },
        "ArticleLocale":{
            "title":"Article Locale",
            "maxLength":10,
            "type":"string",
            "description":"The locale of the knowledge management article.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the reference to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentId":{
            "title":"Document ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique document identifier associated with the referenced article.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HelpfulFlag":{
            "title":"Helpful",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference was helpful.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 ID of the user who last updated the service request reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service request reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedFlag":{
            "title":"Linked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the reference is linked with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Indicates whether the object is referenced to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The object type of the reference object.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the current reference record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type between the service request and the referenced object.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the referenced object helps in resolving the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SharedFlag":{
            "title":"Shared",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference is shared with the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "Subject":{
            "title":"Title",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the referenced object.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether 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

ResolutionCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_REF_RESOLUTION_CD

The following properties are defined on the LOV link relation:

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

Back to Top