Jump to

• Request
• Response

Update a data source

patch

/fscmRestApi/resources/11.13.18.05/advancedControlsDatasources/{DatasourceId}

Request

Path Parameters

• DatasourceId(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

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• Active: string
  Read Only: true

  Maximum Length: 4000

  Indicates if the data source is active or not.
• DatasourceBindKey: string
  Read Only: true

  Maximum Length: 1000

  The unique bind key of the data source.
• DatasourceId: integer (int64)
  Read Only: true

  The ID of the data source.
• DatasourceName: string
  Read Only: true

  Maximum Length: 4000

  The name of the data source.
• DatasourceTypeId: integer (int64)
  Read Only: true

  The type ID of the data source.
• DatasourceTypeName: string
  Read Only: true

  Maximum Length: 4000

  The type name of the data source.
• DefaultDatasource: string
  Read Only: true

  Maximum Length: 1

  Indicates if the data source is the default data source.
• JobType: string
  Read Only: true

  Maximum Length: 12

  The job type used to identify the sync job for a particular data source.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Setup: integer
  Read Only: true

  Indicates if the connection parameters for a data source have been saved and if the data source has been set up successfully.

{
    "type":"object",
    "properties":{
        "Active":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates if the data source is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DatasourceId":{
            "type":"integer",
            "description":"The ID of the data source.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "DatasourceName":{
            "maxLength":4000,
            "type":"string",
            "description":"The name of the data source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobType":{
            "maxLength":12,
            "type":"string",
            "description":"The job type used to identify the sync job for a particular data source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DatasourceBindKey":{
            "maxLength":1000,
            "type":"string",
            "description":"The unique bind key of the data source.",
            "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"
            }
        },
        "DatasourceTypeName":{
            "maxLength":4000,
            "type":"string",
            "description":"The type name of the data source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DatasourceTypeId":{
            "type":"integer",
            "description":"The type ID of the data source.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "Setup":{
            "type":"integer",
            "description":"Indicates if the connection parameters for a data source have been saved and if the data source has been set up successfully.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultDatasource":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the data source is the default data source.",
            "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 : 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