Jump to

• Request
• Response
• Examples

Update the source for a configurator

patch

/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts/{SourceAssignmentId}

Request

Path Parameters

• ConfiguratorId(required): integer(int64)
  Unique identifier for a configurator.
• SourceAssignmentId(required): integer(int64)
  Unique identifier for configurator source assignment.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• SourceName: string
  Title: Source Name

  Maximum Length: 120

  Indicates the name for the configurator source.
• UserFilter: string
  Title: Filter

  Maximum Length: 2000

  The user entered filter for the configurator source assignment.

{
    "type":"object",
    "properties":{
        "UserFilter":{
            "title":"Filter",
            "maxLength":"2000",
            "type":"string",
            "description":"The user entered filter for the configurator source assignment.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceName":{
            "title":"Source Name",
            "maxLength":"120",
            "type":"string",
            "description":"Indicates the name for the configurator source.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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 : projectProcessConfigurators-SourceAsgnmts-item-response

Type: object

Show Source

• Alias: string
  Title: Alias

  Maximum Length: 80

  The user provided alias for each configurator source assignment.
• ConfiguratorId: integer (int64)
  Title: Configurator ID

  Unique identifier for a configurator.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

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

  Unique identifier for configurator source assignment.
• SourceName: string
  Title: Source Name

  Maximum Length: 120

  Indicates the name for the configurator source.
• UserFilter: string
  Title: Filter

  Maximum Length: 2000

  The user entered filter for the configurator source assignment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConfiguratorId":{
            "title":"Configurator ID",
            "type":"integer",
            "description":"Unique identifier for a configurator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Alias":{
            "title":"Alias",
            "maxLength":"80",
            "type":"string",
            "description":"The user provided alias for each configurator source assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "UserFilter":{
            "title":"Filter",
            "maxLength":"2000",
            "type":"string",
            "description":"The user entered filter for the configurator source assignment.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceAssignmentId":{
            "title":"Source Assignment ID",
            "type":"integer",
            "description":"Unique identifier for configurator source assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceName":{
            "title":"Source Name",
            "maxLength":"120",
            "type":"string",
            "description":"Indicates the name for the configurator source.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Examples

The following example shows how to update the source for a configurator by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275142/child/SourceAsgnmts/300100176473539

Request Body Example

The following shows an example of the request body in JSON format.

{"UserFilter": "\"Event Type\" = 'abxc' 'AND' \"Revenue Category\" = ''"}

Response Body Example

The following shows an example of the response body in JSON format.

     {
        "SourceAssignmentId": 300100175275143,
        "Alias": "CalculationLevelEventRevenueinContractCurrencyITD",
        "ConfiguratorId": 300100175275142,
        "CreatedBy": "ABRAHAM.MASON",
        "CreationDate": "2019-03-04T10:48:14.137+00:00",
        "LastUpdateDate": "2019-03-04T12:47:16+00:00",
        "LastUpdatedBy": "ABRAHAM.MASON",
        "UserFilter": "\"Event Type\" = 'abxc' 'AND' \"Revenue Category\" = ''",
        "SourceName": "Calculation Level Event Revenue in Contract Currency - ITD",
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275142/child/SourceAsgnmts/300100175275143",
                "name": "SourceAsgnmts",
                "kind": "item",
                "properties": {
                    "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                }
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275142/child/SourceAsgnmts/300100175275143",
                "name": "SourceAsgnmts",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275142",
                "name": "projectProcessConfigurators",
                "kind": "item"
            },
            {
                "rel": "lov",
                "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275142/child/SourceAsgnmts/300100175275143/lov/ConfiguratorSourcesVA",
                "name": "ConfiguratorSourcesVA",
                "kind": "collection"
            }
        ]
    }

Back to Top